1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\ExampleSettingsPlugin;
use Piwik\Settings\Setting;
use Piwik\Settings\FieldConfig;
/**
* Defines Settings for ExampleSettingsPlugin.
*
* Usage like this:
* $settings = new UserSettings();
* $settings->autoRefresh->getValue();
* $settings->color->getValue();
*/
class UserSettings extends \Piwik\Settings\Plugin\UserSettings
{
/** @var Setting */
public $autoRefresh;
/** @var Setting */
public $refreshInterval;
/** @var Setting */
public $color;
protected function init()
{
// User setting --> checkbox converted to bool
$this->autoRefresh = $this->createAutoRefreshSetting();
// User setting --> textbox converted to int defining a validator and filter
$this->refreshInterval = $this->createRefreshIntervalSetting();
// User setting --> radio
$this->color = $this->createColorSetting();
}
private function createAutoRefreshSetting()
{
return $this->makeSetting('autoRefresh', $default = false, FieldConfig::TYPE_BOOL, function (FieldConfig $field) {
$field->title = 'Auto refresh';
$field->uiControl = FieldConfig::UI_CONTROL_CHECKBOX;
$field->description = 'If enabled, the value will be automatically refreshed depending on the specified interval';
});
}
private function createRefreshIntervalSetting()
{
return $this->makeSetting('refreshInterval', $default = '30', FieldConfig::TYPE_INT, function (FieldConfig $field) {
$field->title = 'Refresh Interval';
$field->uiControl = FieldConfig::UI_CONTROL_TEXT;
$field->uiControlAttributes = array('size' => 3);
$field->description = 'Defines how often the value should be updated';
$field->inlineHelp = 'Enter a number which is >= 15';
$field->validate = function ($value, $setting) {
if ($value < 15) {
throw new \Exception('Value is invalid');
}
};
});
}
private function createColorSetting()
{
return $this->makeSetting('color', $default = 'red', FieldConfig::TYPE_STRING, function (FieldConfig $field) {
$field->title = 'Color';
$field->uiControl = FieldConfig::UI_CONTROL_RADIO;
$field->description = 'Pick your favourite color';
$field->availableValues = array('red' => 'Red', 'blue' => 'Blue', 'green' => 'Green');
});
}
}
|
