SystemConfigSetting.php
2 years ago
SystemSetting.php
2 years ago
SystemSettings.php
2 years ago
UserSetting.php
2 years ago
UserSettings.php
2 years ago
SystemSettings.php
104 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | * |
| 9 | */ |
| 10 | namespace Piwik\Settings\Plugin; |
| 11 | |
| 12 | use Piwik\Piwik; |
| 13 | use Piwik\Settings\Settings; |
| 14 | /** |
| 15 | * Base class of all system settings providers. Plugins that define their own configuration settings |
| 16 | * can extend this class to easily make their system settings available to Piwik users. |
| 17 | * |
| 18 | * Descendants of this class should implement the {@link init()} method and call the |
| 19 | * {@link makeSetting()} method to create a system setting for this plugin. |
| 20 | * |
| 21 | * For an example, see {@link Piwik\Plugins\ExampleSettingsPlugin\SystemSettings}. |
| 22 | * |
| 23 | * $systemSettings = new Piwik\Plugins\ExampleSettingsPlugin\SystemSettings(); // get instance via dependency injection |
| 24 | * $systemSettings->yourSetting->getValue(); |
| 25 | * |
| 26 | * @api |
| 27 | */ |
| 28 | abstract class SystemSettings extends Settings |
| 29 | { |
| 30 | /** |
| 31 | * Constructor. |
| 32 | */ |
| 33 | public function __construct() |
| 34 | { |
| 35 | parent::__construct(); |
| 36 | $this->init(); |
| 37 | } |
| 38 | /** |
| 39 | * Creates a new system setting. |
| 40 | * |
| 41 | * Settings will be displayed in the UI depending on the order of `makeSetting` calls. This means you can define |
| 42 | * the order of the displayed settings by calling makeSetting first for more important settings. |
| 43 | * |
| 44 | * @param string $name The name of the setting that shall be created |
| 45 | * @param mixed $defaultValue The default value for this setting. Note the value will not be converted to the |
| 46 | * specified type. |
| 47 | * @param string $type The PHP internal type the value of this setting should have. |
| 48 | * Use one of FieldConfig::TYPE_* constants |
| 49 | * @param \Closure $fieldConfigCallback A callback method to configure the field that shall be displayed in the |
| 50 | * UI to define the value for this setting |
| 51 | * @return SystemSetting Returns an instance of the created measurable setting. |
| 52 | */ |
| 53 | protected function makeSetting($name, $defaultValue, $type, $fieldConfigCallback) |
| 54 | { |
| 55 | $setting = new \Piwik\Settings\Plugin\SystemSetting($name, $defaultValue, $type, $this->pluginName); |
| 56 | $setting->setConfigureCallback($fieldConfigCallback); |
| 57 | $this->addSetting($setting); |
| 58 | return $setting; |
| 59 | } |
| 60 | /** |
| 61 | * This is only meant for some core features used by some core plugins that are shipped with Piwik |
| 62 | * @internal |
| 63 | * @ignore |
| 64 | * @param string $configSectionName |
| 65 | * @param $name |
| 66 | * @param $defaultValue |
| 67 | * @param $type |
| 68 | * @param $fieldConfigCallback |
| 69 | * @return SystemSetting |
| 70 | * @throws \Exception |
| 71 | */ |
| 72 | protected function makeSettingManagedInConfigOnly($configSectionName, $name, $defaultValue, $type, $fieldConfigCallback) |
| 73 | { |
| 74 | $setting = new \Piwik\Settings\Plugin\SystemConfigSetting($name, $defaultValue, $type, $this->pluginName, $configSectionName); |
| 75 | $setting->setConfigureCallback($fieldConfigCallback); |
| 76 | $this->addSetting($setting); |
| 77 | return $setting; |
| 78 | } |
| 79 | /** |
| 80 | * Saves (persists) the current setting values in the database. |
| 81 | * |
| 82 | * Will trigger an event to notify plugins that a value has been changed. |
| 83 | */ |
| 84 | public function save() |
| 85 | { |
| 86 | parent::save(); |
| 87 | /** |
| 88 | * Triggered after system settings have been updated. |
| 89 | * |
| 90 | * **Example** |
| 91 | * |
| 92 | * Piwik::addAction('SystemSettings.updated', function (SystemSettings $settings) { |
| 93 | * if ($settings->getPluginName() === 'PluginName') { |
| 94 | * $value = $settings->someSetting->getValue(); |
| 95 | * // Do something with the new setting value |
| 96 | * } |
| 97 | * }); |
| 98 | * |
| 99 | * @param Settings $settings The plugin settings object. |
| 100 | */ |
| 101 | Piwik::postEvent('SystemSettings.updated', array($this)); |
| 102 | } |
| 103 | } |
| 104 |