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
UserSetting.php
72 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\Container\StaticContainer; |
| 13 | use Piwik\Piwik; |
| 14 | use Exception; |
| 15 | use Piwik\Settings\Setting; |
| 16 | |
| 17 | /** |
| 18 | * Describes a per user setting. Each user will be able to change this setting for themselves, |
| 19 | * but not for other users. |
| 20 | * |
| 21 | * See {@link \Piwik\Settings\Setting}. |
| 22 | */ |
| 23 | class UserSetting extends Setting |
| 24 | { |
| 25 | /** |
| 26 | * @var null|string |
| 27 | */ |
| 28 | private $userLogin = null; |
| 29 | |
| 30 | /** |
| 31 | * Constructor. |
| 32 | * |
| 33 | * @param string $name The setting's persisted name. |
| 34 | * @param mixed $defaultValue Default value for this setting if no value was specified. |
| 35 | * @param string $type Eg an array, int, ... see TYPE_* constants |
| 36 | * @param string $pluginName The name of the plugin the setting belongs to |
| 37 | * @param string $userLogin The name of the user the value should be set or get for |
| 38 | * @throws Exception |
| 39 | */ |
| 40 | public function __construct($name, $defaultValue, $type, $pluginName, $userLogin) |
| 41 | { |
| 42 | parent::__construct($name, $defaultValue, $type, $pluginName); |
| 43 | |
| 44 | if (empty($userLogin)) { |
| 45 | throw new Exception('No userLogin given to create setting ' . $name); |
| 46 | } |
| 47 | |
| 48 | $this->userLogin = $userLogin; |
| 49 | |
| 50 | $factory = StaticContainer::get('Piwik\Settings\Storage\Factory'); |
| 51 | $this->storage = $factory->getPluginStorage($this->pluginName, $this->userLogin); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Returns `true` if this setting can be displayed for the current user, `false` if otherwise. |
| 56 | * |
| 57 | * @return bool |
| 58 | */ |
| 59 | public function isWritableByCurrentUser() |
| 60 | { |
| 61 | if (isset($this->hasWritePermission)) { |
| 62 | return $this->hasWritePermission; |
| 63 | } |
| 64 | |
| 65 | // performance improvement, do not detect this in __construct otherwise likely rather "big" query to DB. |
| 66 | $this->hasWritePermission = Piwik::isUserHasSomeViewAccess(); |
| 67 | |
| 68 | return $this->hasWritePermission; |
| 69 | } |
| 70 | |
| 71 | } |
| 72 |