Rev 1177 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
261 | daniel-mar | 1 | <?php |
2 | |||
3 | /* |
||
4 | * OIDplus 2.0 |
||
1086 | daniel-mar | 5 | * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft |
261 | daniel-mar | 6 | * |
7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
||
8 | * you may not use this file except in compliance with the License. |
||
9 | * You may obtain a copy of the License at |
||
10 | * |
||
11 | * http://www.apache.org/licenses/LICENSE-2.0 |
||
12 | * |
||
13 | * Unless required by applicable law or agreed to in writing, software |
||
14 | * distributed under the License is distributed on an "AS IS" BASIS, |
||
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||
16 | * See the License for the specific language governing permissions and |
||
17 | * limitations under the License. |
||
18 | */ |
||
19 | |||
1050 | daniel-mar | 20 | namespace ViaThinkSoft\OIDplus; |
511 | daniel-mar | 21 | |
1086 | daniel-mar | 22 | // phpcs:disable PSR1.Files.SideEffects |
23 | \defined('INSIDE_OIDPLUS') or die; |
||
24 | // phpcs:enable PSR1.Files.SideEffects |
||
25 | |||
294 | daniel-mar | 26 | // OIDplusBaseConfig is the basic ("static") configuration stored in userdata/baseconfig/config.inc.php, |
261 | daniel-mar | 27 | // e.g. database access credentials. |
28 | // Not to be confused with OIDplusConfig which are settings that are stored in the database. |
||
730 | daniel-mar | 29 | class OIDplusBaseConfig extends OIDplusBaseClass implements OIDplusGetterSetterInterface { |
261 | daniel-mar | 30 | |
1130 | daniel-mar | 31 | /** |
32 | * @var array |
||
33 | */ |
||
261 | daniel-mar | 34 | protected $data = array(); |
35 | |||
1116 | daniel-mar | 36 | /** |
1177 | daniel-mar | 37 | * @return string[] |
38 | */ |
||
39 | public function getAllKeys(): array { |
||
40 | // TODO: put this method into the interface OIDplusGetterSetterInterface |
||
41 | return array_keys($this->data); |
||
42 | } |
||
43 | |||
44 | /** |
||
1116 | daniel-mar | 45 | * @param string $name |
46 | * @param mixed|null $default |
||
47 | * @return mixed|null |
||
48 | */ |
||
49 | public function getValue(string $name, $default=null) { |
||
1282 | daniel-mar | 50 | if ($name == 'SERVER_SECRET') { |
51 | $caller_class = debug_backtrace()[1]['class']; |
||
52 | if (!str_starts_with($caller_class, 'ViaThinkSoft\\OIDplus\\')) { |
||
53 | throw new OIDplusException(_L('Outdated plugin: Calling %1 from a plugin is deprecated. Please use %2 instead', 'SERVER_SECRET', 'OIDplus::authUtils()->makeSecret()')); |
||
54 | } |
||
55 | } |
||
261 | daniel-mar | 56 | return $this->exists($name) ? $this->data[$name] : $default; |
57 | } |
||
58 | |||
1116 | daniel-mar | 59 | /** |
60 | * @param string $name |
||
61 | * @param mixed $value |
||
62 | * @return void |
||
63 | */ |
||
64 | public function setValue(string $name, $value) { |
||
569 | daniel-mar | 65 | // Note: The value is only set at run time level! |
326 | daniel-mar | 66 | // This function will NOT change the userdata/baseconfig/config.inc.php file! |
261 | daniel-mar | 67 | $this->data[$name] = $value; |
68 | } |
||
69 | |||
1116 | daniel-mar | 70 | /** |
71 | * @param string $name |
||
72 | * @return void |
||
73 | */ |
||
74 | public function delete(string $name) { |
||
569 | daniel-mar | 75 | // Note: The value is only deleted at run time level! |
76 | // This function will NOT change the userdata/baseconfig/config.inc.php file! |
||
261 | daniel-mar | 77 | unset($this->data[$name]); |
78 | } |
||
79 | |||
1116 | daniel-mar | 80 | /** |
81 | * @param string $name |
||
82 | * @return bool |
||
83 | */ |
||
84 | public function exists(string $name): bool { |
||
261 | daniel-mar | 85 | return isset($this->data[$name]); |
86 | } |
||
87 | |||
88 | } |