← All changes | src/Config/ConfigParameter.php +57 -10 2.3.13 → 2.2.2 View file →

		@@ -1,5 +1,18 @@
1	1	<?php
	2	+/**
	3	+ * ConfigParameter.php
	4	+ *
	5	+ * The ConfigParameter class file.
	6	+ *
	7	+ * PHP versions 5
	8	+ *
	9	+ * @author Alexander Schneider <alexanderschneider85@gmail.com>
	10	+ * @copyright 2008-2017 Alexander Schneider
	11	+ * @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2
	12	+ * @version SVN: $id$
	13	+ * @link http://wordpress.org/extend/plugins/user-access-manager/
	14	+ */
2	15
3	16	declare(strict_types=1);
4	17
5	18	namespace UserAccessManager\Config;
		@@ -5,24 +18,48 @@
5	18	namespace UserAccessManager\Config;
6	19
7	20	use Exception;
8	21
	22	+/**
	23	+ * Class ConfigParameter
	24	+ *
	25	+ * @package UserAccessManager\Config
	26	+ */
9	27	abstract class ConfigParameter implements ConfigParameterInterface
10	28	{
11		- protected mixed $defaultValue = null;
12		- protected mixed $value = null;
	29	+ /**
	30	+ * @var string
	31	+ */
	32	+ protected $id;
13	33
14	34	/**
	35	+ * @var mixed
	36	+ */
	37	+ protected $defaultValue = null;
	38	+
	39	+ /**
	40	+ * @var mixed
	41	+ */
	42	+ protected $value = null;
	43	+
	44	+ /**
	45	+ * ConfigParameter constructor.
	46	+ * @param string $id
	47	+ * @param mixed $defaultValue
15	48	* @throws Exception
16	49	*/
17		- public function __construct(
18		- protected string $id,
19		- mixed $defaultValue = null
20		- ) {
	50	+ public function __construct(string $id, $defaultValue = null)
	51	+ {
	52	+ $this->id = $id;
	53	+
21	54	$this->validateValue($defaultValue);
22	55	$this->defaultValue = $defaultValue;
23	56	}
24	57
	58	+ /**
	59	+ * Returns the id.
	60	+ * @return string
	61	+ */
25	62	public function getId(): string
26	63	{
27	64	return $this->id;
28	65	}
		@@ -27,24 +64,34 @@
27	64	return $this->id;
28	65	}
29	66
30	67	/**
	68	+ * Checks the value type and throws an exception if the value isn't the required type.
	69	+ * @param mixed $value
31	70	* @throws Exception
32	71	*/
33		- protected function validateValue($value): void
	72	+ protected function validateValue($value)
34	73	{
35	74	if ($this->isValidValue($value) === false) {
36		- throw new Exception("Wrong value '$value' type given for '$this->id'.'");
	75	+ throw new Exception("Wrong value '{$value}' type given for '{$this->id}'.'");
37	76	}
38	77	}
39	78
40		- public function setValue(mixed $value): void
	79	+ /**
	80	+ * Sets the current value.
	81	+ * @param mixed $value
	82	+ */
	83	+ public function setValue($value)
41	84	{
42	85	$this->isValidValue($value);
43	86	$this->value = $value;
44	87	}
45	88
46		- public function getValue(): mixed
	89	+ /**
	90	+ * Returns the current parameter value.
	91	+ * @return mixed
	92	+ */
	93	+ public function getValue()
47	94	{
48	95	return ($this->value === null) ? $this->defaultValue : $this->value;
49	96	}
50	97	}