blob: 8181502c7bc34673bbaefde5ee4e9831258ab37b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Settings;
/**
* Base class of all settings providers.
*
* @api
*/
abstract class Settings
{
/**
* An array containing all available settings: Array ( [setting-name] => [setting] )
*
* @var Setting[]
*/
private $settings = array();
protected $pluginName;
/**
* By default the plugin name is shown in the UI when managing plugin settings. However, you can overwrite
* the displayed title by specifying a title.
* @var string
*/
protected $title = '';
public function __construct()
{
if (!isset($this->pluginName)) {
$classname = get_class($this);
$parts = explode('\\', $classname);
if (count($parts) >= 3) {
$this->pluginName = $parts[2];
} else {
throw new \Exception(sprintf('Plugin Settings must have a plugin name specified in %s, could not detect plugin name', $classname));
}
}
}
public function getTitle()
{
if (!empty($this->title)) {
return $this->title;
}
return $this->pluginName;
}
/**
* @ignore
*/
public function getPluginName()
{
return $this->pluginName;
}
/**
* @ignore
* @return Setting
*/
public function getSetting($name)
{
if (array_key_exists($name, $this->settings)) {
return $this->settings[$name];
}
}
/**
* Implemented by descendants. This method should define plugin settings (via the
* {@link addSetting()}) method and set the introduction text (via the
* {@link setIntroduction()}).
*/
abstract protected function init();
/**
* Returns the settings that can be displayed for the current user.
*
* @return Setting[]
*/
public function getSettingsWritableByCurrentUser()
{
return array_filter($this->settings, function (Setting $setting) {
return $setting->isWritableByCurrentUser();
});
}
/**
* Makes a new plugin setting available.
*
* @param Setting $setting
* @throws \Exception If there is a setting with the same name that already exists.
* If the name contains non-alphanumeric characters.
*/
protected function addSetting(Setting $setting)
{
$name = $setting->getName();
if (isset($this->settings[$name])) {
throw new \Exception(sprintf('A setting with name "%s" does already exist for plugin "%s"', $name, $this->pluginName));
}
$this->settings[$name] = $setting;
}
/**
* Saves (persists) the current setting values in the database.
*/
public function save()
{
foreach ($this->settings as $setting) {
$setting->save();
}
}
}
|
