MeasurableProperty.php
5 years ago
MeasurableSetting.php
5 years ago
MeasurableSettings.php
5 years ago
MeasurableProperty.php
89 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\Measurable; |
| 11 | |
| 12 | use Piwik\Container\StaticContainer; |
| 13 | use Piwik\Piwik; |
| 14 | use Exception; |
| 15 | |
| 16 | /** |
| 17 | * Describes a Measurable property for a measurable type such as a website, a mobile app, .... |
| 18 | * |
| 19 | * The difference to {@link MeasurableSetting} is that these fields will be stored in the actual site table whereas |
| 20 | * MeasurableSetting will be stored in a site_settings table. For this reasons MeasurableProperty can be used only |
| 21 | * for some specific fields that already exist in site table such as "ecommerce", "sitesearch" etc. |
| 22 | * |
| 23 | * See {@link \Piwik\Settings\Setting}. |
| 24 | */ |
| 25 | class MeasurableProperty extends \Piwik\Settings\Setting |
| 26 | { |
| 27 | /** |
| 28 | * @var int |
| 29 | */ |
| 30 | private $idSite = 0; |
| 31 | |
| 32 | private $allowedNames = array( |
| 33 | 'ecommerce', 'sitesearch', 'sitesearch_keyword_parameters', |
| 34 | 'sitesearch_category_parameters', |
| 35 | 'exclude_unknown_urls', 'excluded_ips', 'excluded_parameters', |
| 36 | 'excluded_user_agents', 'keep_url_fragment', 'urls', 'group' |
| 37 | ); |
| 38 | |
| 39 | /** |
| 40 | * Constructor. |
| 41 | * |
| 42 | * @param string $name The persisted name of the setting. |
| 43 | * @param mixed $defaultValue Default value for this setting if no value was specified. |
| 44 | * @param string $type Eg an array, int, ... see TYPE_* constants |
| 45 | * @param string $pluginName The name of the plugin the setting belongs to. |
| 46 | * @param int $idSite The idSite this property belongs to. |
| 47 | * @throws Exception |
| 48 | */ |
| 49 | public function __construct($name, $defaultValue, $type, $pluginName, $idSite) |
| 50 | { |
| 51 | if (!in_array($name, $this->allowedNames)) { |
| 52 | throw new Exception(sprintf('Name "%s" is not allowed to be used with a MeasurableProperty, use a MeasurableSetting instead.', $name)); |
| 53 | } |
| 54 | |
| 55 | parent::__construct($name, $defaultValue, $type, $pluginName); |
| 56 | |
| 57 | $this->idSite = $idSite; |
| 58 | |
| 59 | $storageFactory = StaticContainer::get('Piwik\Settings\Storage\Factory'); |
| 60 | $this->storage = $storageFactory->getSitesTable($idSite); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Returns `true` if this setting can be displayed for the current user, `false` if otherwise. |
| 65 | * |
| 66 | * @return bool |
| 67 | */ |
| 68 | public function isWritableByCurrentUser() |
| 69 | { |
| 70 | if (isset($this->hasWritePermission)) { |
| 71 | return $this->hasWritePermission; |
| 72 | } |
| 73 | |
| 74 | // performance improvement, do not detect this in __construct otherwise likely rather "big" query to DB. |
| 75 | if ($this->hasSiteBeenCreated()) { |
| 76 | $this->hasWritePermission = Piwik::isUserHasAdminAccess($this->idSite); |
| 77 | } else { |
| 78 | $this->hasWritePermission = Piwik::hasUserSuperUserAccess(); |
| 79 | } |
| 80 | |
| 81 | return $this->hasWritePermission; |
| 82 | } |
| 83 | |
| 84 | private function hasSiteBeenCreated() |
| 85 | { |
| 86 | return !empty($this->idSite); |
| 87 | } |
| 88 | } |
| 89 |