PDF rausgenommen

msd2/tracking/piwik/core/Settings/FieldConfig/ArrayField.php

@@ -0,0 +1,79 @@
+<?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\FieldConfig;
+
+/**
+ * Lets you configure a field for a field array.
+ *
+ * Usage:
+ *
+ * $field->uiControl = FieldConfig::UI_CONTROL_FIELD_ARRAY;
+ * $arrayField = new FieldConfig\ArrayField('Index', FieldConfig::UI_CONTROL_TEXT);
+ * $field->uiControlAttributes['field'] = $field->toArray();
+ *
+ * @api
+ */
+class ArrayField
+{
+    /**
+     * 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;
+
+    /**
+     * Defines a custom template file for a UI control. This file should render a UI control and expose the value in a
+     * "formField.value" angular model. For an example see "plugins/CorePluginsAdmin/angularjs/form-field/field-text.html"
+     *
+     * @var string
+     */
+    public $customUiControlTemplateFile = '';
+
+    /**
+     * 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, $uiControl = 'text')
+    {
+        $this->title = $title;
+        $this->uiControl = $uiControl;
+    }
+
+    public function toArray()
+    {
+        return array(
+            'title' => $this->title,
+            'uiControl' => $this->uiControl,
+            'templateFile' => $this->customUiControlTemplateFile,
+            'availableValues' => $this->availableValues,
+        );
+    }
+
+}

msd2/tracking/piwik/core/Settings/FieldConfig/MultiPair.php

@@ -0,0 +1,89 @@
+<?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\FieldConfig;
+
+/**
+ * Lets you configure a multi pair field.
+ *
+ * Usage:
+ *
+ * $field->uiControl = FieldConfig::UI_CONTROL_MULTI_PAIR;
+ * $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;
+
+    /**
+     * Defines a custom template file for a UI control. This file should render a UI control and expose the value in a
+     * "formField.value" angular model. For an example see "plugins/CorePluginsAdmin/angularjs/form-field/field-text.html"
+     *
+     * @var string
+     */
+    public $customUiControlTemplateFile = '';
+
+    /**
+     * 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,
+            'templateFile' => $this->customUiControlTemplateFile,
+            'availableValues' => $this->availableValues,
+        );
+    }
+
+}