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