| Свойство |
Тип |
Описание |
|
| $availableValues |
null | array |
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._ |
|
| $condition |
string |
For example 'sitesearch', or 'sitesearch && !use_sitesearch_default' where 'sitesearch' and 'use_sitesearch_default'
are both values of fields. |
|
| $description |
null | string |
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. |
|
| $inlineHelp |
null | string |
Be sure to escape any user input as HTML can be used here. |
|
| $introduction |
null | string |
Text that will appear above this setting's section in the _Plugin Settings_ admin page. |
|
| $title |
string |
Be sure to escape any user input as HTML can be used here. |
|
| $transform |
null | Closure |
_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;
} |
|
| $uiControl |
string |
See {@link Piwik\Plugin\Settings} for a list of supported control types. |
|
| $uiControlAttributes |
array |
Name-value mapping of HTML attributes that will be added HTML form control, eg,
array('size' => 3). Attributes will be escaped before outputting. |
|
| $validate |
null | Closure |
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.');
}
} |
|
