/
PluginSettings.php
79 lines (68 loc) · 2.05 KB
/
PluginSettings.php
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
<?php
namespace Elgg\Traits\Entity;
/**
* Handle CRUD for plugin settings
*
* @since 4.0
*/
trait PluginSettings {
/**
* Save a plugin setting
*
* @param string $plugin_id plugin ID
* @param string $name setting name
* @param mixed $value setting value (needs to be a scalar)
*
* @return bool
*/
public function setPluginSetting(string $plugin_id, string $name, $value): bool {
$value = _elgg_services()->hooks->trigger('plugin_setting', $this->getType(), [
'entity' => $this,
'plugin_id' => $plugin_id,
'name' => $name,
'value' => $value,
], $value);
if (isset($value) && !is_scalar($value)) {
elgg_log("Invalid value type provided to save plugin setting '{$name}' for plugin '{$plugin_id}' only scalars are allowed", 'ERROR');
return false;
}
$name = $this->getNamespacedPluginSettingName($plugin_id, $name);
return $this->setPrivateSetting($name, $value);
}
/**
* Get a plugin setting
*
* @param string $plugin_id plugin ID
* @param string $name setting name
* @param mixed $default default setting value (will be cast to string)
*
* @return string
*/
public function getPluginSetting(string $plugin_id, string $name, $default = null): string {
$name = $this->getNamespacedPluginSettingName($plugin_id, $name);
return (string) ($this->getPrivateSetting($name) ?? $default);
}
/**
* Remove a plugin setting
*
* @param string $plugin_id plugin ID
* @param string $name setting name
*
* @return bool
*/
public function removePluginSetting(string $plugin_id, string $name): bool {
$name = $this->getNamespacedPluginSettingName($plugin_id, $name);
return $this->removePrivateSetting($name);
}
/**
* Get the namespaced private setting name where the plugin setting is saved
*
* @param string $plugin_id plugin ID
* @param string $name setting name
*
* @return string
*/
final public function getNamespacedPluginSettingName(string $plugin_id, string $name): string {
return "plugin:{$this->getType()}_setting:{$plugin_id}:{$name}";
}
}