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
|
<?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\Settings\FieldConfig;
/**
* Lets you configure a multi pair field.
*
* Usage:
*
* $field->uiControl = FieldConfig::UI_CONTROL_MULTI_TUPLE;
* $field1 = new FieldConfig\MultiPair('Index', 'index', FieldConfig::UI_CONTROL_TEXT);
* $field2 = new FieldConfig\MultiPair('Value', 'value', FieldConfig::UI_CONTROL_TEXT);
* $field->uiControlAttributes['field1'] = $field1->toArray();
* $field->uiControlAttributes['field2'] = $field2->toArray();
*
* @api
*/
class MultiPair
{
/**
* The name of the key the index should have eg "dimension" will make an index array(array('dimension' => '...'))
* @var string
*/
public $key = '';
/**
* 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;
/**
* Array like ['plugin' => 'MyPlugin', 'component' => 'MyExportedCustomFieldComponent']. For an example see
* "plugins/CorePluginsAdmin/vue/src/FormField/FieldText.vue"
*
* @var string[]
*/
public $customFieldComponent = 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 = '';
/**
* 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.
*
* @var null|array
*/
public $availableValues = null;
public function __construct($title, $key, $uiControl = 'text')
{
$this->title = $title;
$this->key = $key;
$this->uiControl = $uiControl;
}
public function toArray()
{
return array(
'key' => $this->key,
'title' => $this->title,
'uiControl' => $this->uiControl,
'component' => $this->customFieldComponent,
'availableValues' => $this->availableValues,
);
}
}
|
