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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Settings;
/**
* Lets you configure a form field.
*
* @api
*/
class FieldConfig
{
/**
* Shows a radio field. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_RADIO = 'radio';
/**
* Shows a text field. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_TEXT = 'text';
/**
* Shows a text area. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_TEXTAREA = 'textarea';
/**
* Shows a checkbox. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_CHECKBOX = 'checkbox';
/**
* Shows a password field. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_PASSWORD = 'password';
/**
* Shows a select field where a user can select multiple values.
* The type "Array" is required for this ui control. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_MULTI_SELECT = 'multiselect';
/**
* Shows a select field. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_SINGLE_SELECT = 'select';
/**
* Generates a hidden form field. To use this field assign it to the `$uiControl` property.
*/
const UI_CONTROL_HIDDEN = 'hidden';
/**
* Expects an integer value. Is usually used when creating a setting.
*/
const TYPE_INT = 'integer';
/**
* Expects a float value. Is usually used when creating a setting.
*/
const TYPE_FLOAT = 'float';
/**
* Expects a string. Is usually used when creating a setting.
*/
const TYPE_STRING = 'string';
/**
* Expects a boolean. Is usually used when creating a setting.
*/
const TYPE_BOOL = 'boolean';
/**
* Expects an array containing multiple values.
*/
const TYPE_ARRAY = 'array';
/**
* Describes what HTML element should be used to manipulate the setting through Piwik's UI.
*
* See {@link Piwik\Plugin\Settings} for a list of supported control types.
*
* @var string
*/
public $uiControl = null;
/**
* Name-value mapping of HTML attributes that will be added HTML form control, eg,
* `array('size' => 3)`. Attributes will be escaped before outputting.
*
* @var array
*/
public $uiControlAttributes = array();
/**
* The list of all available values for this setting. If null, the setting can have any value.
*
* If supplied, this field should be an array mapping available values with their prettified
* display value. Eg, if set to `array('nb_visits' => 'Visits', 'nb_actions' => 'Actions')`,
* the UI will display **Visits** and **Actions**, and when the user selects one, Piwik will
* set the setting to **nb_visits** or **nb_actions** respectively.
*
* The setting value will be validated if this field is set. If the value is not one of the
* available values, an error will be triggered.
*
* _Note: If a custom validator is supplied (see {@link $validate}), the setting value will
* not be validated._
*
* @var null|array
*/
public $availableValues = null;
/**
* Text that will appear above this setting's section in the _Plugin Settings_ admin page.
*
* @var null|string
*/
public $introduction = null;
/**
* Text that will appear directly underneath the setting title in the _Plugin Settings_ admin
* page. If set, should be a short description of the setting.
*
* @var null|string
*/
public $description = null;
/**
* Text that will appear next to the setting's section in the _Plugin Settings_ admin page. If set,
* it should contain information about the setting that is more specific than a general description,
* such as the format of the setting value if it has a special format.
*
* Be sure to escape any user input as HTML can be used here.
*
* @var null|string
*/
public $inlineHelp = null;
/**
* A closure that does some custom validation on the setting before the setting is persisted.
*
* The closure should take two arguments: the setting value and the {@link Setting} instance being
* validated. If the value is found to be invalid, the closure should throw an exception with
* a message that describes the error.
*
* **Example**
*
* $setting->validate = function ($value, Setting $setting) {
* if ($value > 60) {
* throw new \Exception('The time limit is not allowed to be greater than 60 minutes.');
* }
* }
*
* @var null|\Closure
*/
public $validate = null;
/**
* A closure that transforms the setting value. If supplied, this closure will be executed after
* the setting has been validated.
*
* _Note: If a transform is supplied, the setting's {@link $type} has no effect. This means the
* transformation function will be responsible for casting the setting value to the appropriate
* data type._
*
* **Example**
*
* $setting->transform = function ($value, Setting $setting) {
* if ($value > 30) {
* $value = 30;
* }
*
* return (int) $value;
* }
*
* @var null|\Closure
*/
public $transform = null;
/**
* This setting's display name, for example, `'Refresh Interval'`.
*
* Be sure to escape any user input as HTML can be used here.
*
* @var string
*/
public $title = '';
/**
* Here you can define conditions so that certain form fields will be only shown when a certain condition
* is true. This condition is supposed to be evaluated on the client side dynamically. This way you can hide
* for example some fields depending on another field. For example if SiteSearch is disabled, fields to enter
* site search keywords is not needed anymore and can be disabled.
*
* For example 'sitesearch', or 'sitesearch && !use_sitesearch_default' where 'sitesearch' and 'use_sitesearch_default'
* are both values of fields.
*
* @var string
*/
public $condition;
}
|
