ConfigParameter.php
2 KB
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
<?php
/**
* ConfigParameter.php
*
* The ConfigParameter class file.
*
* PHP versions 5
*
* @author Alexander Schneider <alexanderschneider85@gmail.com>
* @copyright 2008-2017 Alexander Schneider
* @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2
* @version SVN: $id$
* @link http://wordpress.org/extend/plugins/user-access-manager/
*/
declare(strict_types=1);
namespace UserAccessManager\Config;
use Exception;
/**
* Class ConfigParameter
*
* @package UserAccessManager\Config
*/
abstract class ConfigParameter implements ConfigParameterInterface
{
/**
* @var string
*/
protected $id;
/**
* @var mixed
*/
protected $defaultValue = null;
/**
* @var mixed
*/
protected $value = null;
/**
* ConfigParameter constructor.
* @param string $id
* @param mixed $defaultValue
* @throws Exception
*/
public function __construct(string $id, $defaultValue = null)
{
$this->id = $id;
$this->validateValue($defaultValue);
$this->defaultValue = $defaultValue;
}
/**
* Returns the id.
* @return string
*/
public function getId(): string
{
return $this->id;
}
/**
* Checks the value type and throws an exception if the value isn't the required type.
* @param mixed $value
* @throws Exception
*/
protected function validateValue($value)
{
if ($this->isValidValue($value) === false) {
throw new Exception("Wrong value '{$value}' type given for '{$this->id}'.'");
}
}
/**
* Sets the current value.
* @param mixed $value
*/
public function setValue($value)
{
$this->isValidValue($value);
$this->value = $value;
}
/**
* Returns the current parameter value.
* @return mixed
*/
public function getValue()
{
return ($this->value === null) ? $this->defaultValue : $this->value;
}
}