SystemConfigSetting.php
5 years ago
SystemSetting.php
5 years ago
SystemSettings.php
5 years ago
UserSetting.php
5 years ago
UserSettings.php
5 years ago
SystemSetting.php
98 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Matomo - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | * |
| 8 | */ |
| 9 | |
| 10 | namespace Piwik\Settings\Plugin; |
| 11 | |
| 12 | use Piwik\Config; |
| 13 | use Piwik\Container\StaticContainer; |
| 14 | use Piwik\Piwik; |
| 15 | use Piwik\Settings\Setting; |
| 16 | |
| 17 | /** |
| 18 | * Describes a system wide setting. Only the Super User can change this type of setting by default and |
| 19 | * the value of this setting will affect all users. |
| 20 | * |
| 21 | * See {@link \Piwik\Settings\Setting}. |
| 22 | * |
| 23 | * @api |
| 24 | */ |
| 25 | class SystemSetting extends Setting |
| 26 | { |
| 27 | /** |
| 28 | * Constructor. |
| 29 | * |
| 30 | * @param string $name The setting's persisted name. |
| 31 | * @param mixed $defaultValue Default value for this setting if no value was specified. |
| 32 | * @param string $type Eg an array, int, ... see TYPE_* constants |
| 33 | * @param string $pluginName The name of the plugin the system setting belongs to. |
| 34 | */ |
| 35 | public function __construct($name, $defaultValue, $type, $pluginName) |
| 36 | { |
| 37 | parent::__construct($name, $defaultValue, $type, $pluginName); |
| 38 | |
| 39 | $factory = StaticContainer::get('Piwik\Settings\Storage\Factory'); |
| 40 | $this->storage = $factory->getPluginStorage($this->pluginName, $userLogin = ''); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Returns `true` if this setting is writable for the current user, `false` if otherwise. In case it returns |
| 45 | * writable for the current user it will be visible in the Plugin settings UI. |
| 46 | * |
| 47 | * @return bool |
| 48 | */ |
| 49 | public function isWritableByCurrentUser() |
| 50 | { |
| 51 | if ($this->hasConfigValue()) { |
| 52 | return false; |
| 53 | } |
| 54 | |
| 55 | if (isset($this->hasWritePermission)) { |
| 56 | return $this->hasWritePermission; |
| 57 | } |
| 58 | |
| 59 | // performance improvement, do not detect this in __construct otherwise likely rather "big" query to DB. |
| 60 | $this->hasWritePermission = Piwik::hasUserSuperUserAccess(); |
| 61 | |
| 62 | return $this->hasWritePermission; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * @inheritdoc |
| 67 | */ |
| 68 | public function getValue() |
| 69 | { |
| 70 | $defaultValue = parent::getValue(); // we access value first to make sure permissions are checked |
| 71 | |
| 72 | $configValue = $this->getValueFromConfig(); |
| 73 | |
| 74 | if (isset($configValue)) { |
| 75 | $defaultValue = $configValue; |
| 76 | settype($defaultValue, $this->type); |
| 77 | } |
| 78 | |
| 79 | return $defaultValue; |
| 80 | } |
| 81 | |
| 82 | private function hasConfigValue() |
| 83 | { |
| 84 | $value = $this->getValueFromConfig(); |
| 85 | return isset($value); |
| 86 | } |
| 87 | |
| 88 | private function getValueFromConfig() |
| 89 | { |
| 90 | $config = Config::getInstance()->{$this->pluginName}; |
| 91 | |
| 92 | if (!empty($config) && array_key_exists($this->name, $config)) { |
| 93 | return $config[$this->name]; |
| 94 | } |
| 95 | } |
| 96 | |
| 97 | } |
| 98 |