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
124
125
126
127
128
129
|
<?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\Plugins\CorePluginsAdmin;
use Piwik\Common;
use Piwik\Piwik;
use Piwik\Settings\Setting;
use Piwik\Settings\Settings;
use Exception;
class SettingsMetadata
{
/**
* @param Settings[] $settingsInstances
* @param array $settingValues array('pluginName' => array('settingName' => 'settingValue'))
* @throws Exception;
*/
public function setPluginSettings($settingsInstances, $settingValues)
{
try {
foreach ($settingsInstances as $pluginName => $pluginSetting) {
foreach ($pluginSetting->getSettingsWritableByCurrentUser() as $setting) {
$value = $this->findSettingValueFromRequest($settingValues, $pluginName, $setting->getName());
if (isset($value)) {
$setting->setValue($value);
}
}
}
} catch (Exception $e) {
$message = $e->getMessage();
if (!empty($setting)) {
$title = Piwik::translate(strip_tags($setting->configureField()->title));
throw new Exception($title . ': ' . $message);
}
}
}
private function findSettingValueFromRequest($settingValues, $pluginName, $settingName)
{
if (!array_key_exists($pluginName, $settingValues)) {
return;
}
foreach ($settingValues[$pluginName] as $setting) {
if ($setting['name'] === $settingName) {
$value = null;
if (array_key_exists('value', $setting)) {
$value = $setting['value'];
}
if (is_string($value)) {
return Common::unsanitizeInputValue($value);
}
return $value;
}
}
}
/**
* @param Settings[] $allSettings A list of Settings instead by pluginname
* @return array
*/
public function formatSettings($allSettings)
{
$metadata = array();
foreach ($allSettings as $pluginName => $settings) {
$writableSettings = $settings->getSettingsWritableByCurrentUser();
if (empty($writableSettings)) {
continue;
}
$plugin = array(
'pluginName' => $pluginName,
'title' => $settings->getTitle(),
'settings' => array()
);
foreach ($writableSettings as $writableSetting) {
$plugin['settings'][] = $this->formatMetadata($writableSetting);
}
$metadata[] = $plugin;
}
return $metadata;
}
private function formatMetadata(Setting $setting)
{
$config = $setting->configureField();
$availableValues = $config->availableValues;
if (is_array($availableValues)) {
$availableValues = (object) $availableValues;
}
return array(
'name' => $setting->getName(),
'title' => $config->title,
'value' => $setting->getValue(),
'defaultValue' => $setting->getDefaultValue(),
'type' => $setting->getType(),
'uiControl' => $config->uiControl,
'uiControlAttributes' => $config->uiControlAttributes,
'availableValues' => $availableValues,
'description' => $config->description,
'inlineHelp' => $config->inlineHelp,
'templateFile' => $config->customUiControlTemplateFile,
'introduction' => $config->introduction,
'condition' => $config->condition,
);
}
}
|
