قرینه از
https://github.com/matomo-org/matomo.git
synced 2025-08-22 23:17:46 +00:00
9a3ef94df6
* [Coding Style] Enable rule PSR12.Files.FileHeader * Apply CS * Replace Piwik with Matomo in file headers * Unify file headers (position, no. of lines, https links) * Rebuild dist files * Apply CS * Fix system test that relies on line numbers in a file that had the file header updated --------- Co-authored-by: Stefan Giehl <stefan@matomo.org>
89 خطوط
2.5 KiB
PHP
89 خطوط
2.5 KiB
PHP
<?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,
|
|
);
|
|
}
|
|
}
|