1 | <?php |
||
7 | class SettingsManager |
||
8 | { |
||
9 | /** |
||
10 | * Resource with settings. |
||
11 | * |
||
12 | * @var HasSettings |
||
13 | */ |
||
14 | protected $resource; |
||
15 | |||
16 | /** |
||
17 | * Replaced settings. |
||
18 | * |
||
19 | * @var array |
||
20 | */ |
||
21 | protected $replaced = []; |
||
22 | |||
23 | /** |
||
24 | * SettingsManager constructor. |
||
25 | * |
||
26 | * @param HasSettings $resource |
||
27 | */ |
||
28 | public function __construct(HasSettings $resource) |
||
32 | |||
33 | /** |
||
34 | * Get the resource. |
||
35 | * |
||
36 | * @return HasSettings |
||
37 | */ |
||
38 | public function getResource() |
||
42 | |||
43 | /** |
||
44 | * Returns single setting value (or default value if setting was not found or is NULL). |
||
45 | * |
||
46 | * @param string $setting |
||
47 | * @param null $defaultValue |
||
48 | * |
||
49 | * @return mixed |
||
50 | */ |
||
51 | public function get(string $setting, $defaultValue = null) |
||
57 | |||
58 | /** |
||
59 | * Returns multiple settings values (or replaces missing settings with default values). |
||
60 | * |
||
61 | * @param array $settings |
||
62 | * @param array $defaultValues |
||
63 | * |
||
64 | * @return array |
||
65 | */ |
||
66 | public function getMany(array $settings, array $defaultValues = []) |
||
79 | |||
80 | /** |
||
81 | * Returns string value and performs placeholders replacement. |
||
82 | * |
||
83 | * @param string $setting |
||
84 | * @param array $placeholders |
||
85 | * |
||
86 | * @throws \InvalidArgumentException |
||
87 | * |
||
88 | * @return string |
||
89 | */ |
||
90 | public function getWithPlaceholders(string $setting, array $placeholders = []) |
||
100 | |||
101 | /** |
||
102 | * Performs placeholders replacement in given text. |
||
103 | * |
||
104 | * @param string $value |
||
105 | * @param array $placeholders |
||
106 | * |
||
107 | * @return string |
||
108 | */ |
||
109 | public function replacePlaceholders(string $value, array $placeholders = []) |
||
121 | |||
122 | /** |
||
123 | * Returns in-memory replaced settings. |
||
124 | * |
||
125 | * @param array $settings |
||
126 | * |
||
127 | * @return array |
||
128 | */ |
||
129 | public function getReplaced(array $settings) |
||
133 | |||
134 | /** |
||
135 | * Determines if setting value equals to given value. |
||
136 | * |
||
137 | * @param string $setting |
||
138 | * @param $value |
||
139 | * |
||
140 | * @return bool |
||
141 | */ |
||
142 | public function equals(string $setting, $value): bool |
||
146 | |||
147 | /** |
||
148 | * Updates single setting value. |
||
149 | * |
||
150 | * @param string $setting |
||
151 | * @param $value |
||
152 | * |
||
153 | * @return SettingsManager |
||
154 | */ |
||
155 | public function update(string $setting, $value) |
||
159 | |||
160 | /** |
||
161 | * Updates settings values. |
||
162 | * |
||
163 | * @param array $settings |
||
164 | * |
||
165 | * @return SettingsManager |
||
166 | */ |
||
167 | public function updateMany(array $settings) |
||
173 | |||
174 | /** |
||
175 | * Replaces given settings values in memory storage. |
||
176 | * |
||
177 | * @param array $settings |
||
178 | * @param bool $fullReplacement |
||
179 | * |
||
180 | * @return SettingsManager |
||
181 | */ |
||
182 | public function replace(array $settings, bool $fullReplacement = false) |
||
192 | |||
193 | /** |
||
194 | * Saves replaced settings. |
||
195 | * |
||
196 | * @return $this |
||
197 | */ |
||
198 | public function saveReplaced() |
||
204 | } |
||
205 |