| 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 |
*/ |
| 15 |
namespace UserAccessManager\Config; |
| 16 |
|
| 17 |
/** |
| 18 |
* Class ConfigParameter |
| 19 |
* |
| 20 |
* @package UserAccessManager\Config |
| 21 |
*/ |
| 22 |
abstract class ConfigParameter implements ConfigParameterInterface |
| 23 |
{ |
| 24 |
/** |
| 25 |
* @var string |
| 26 |
*/ |
| 27 |
protected $id; |
| 28 |
|
| 29 |
/** |
| 30 |
* @var mixed |
| 31 |
*/ |
| 32 |
protected $defaultValue = null; |
| 33 |
|
| 34 |
/** |
| 35 |
* @var mixed |
| 36 |
*/ |
| 37 |
protected $value = null; |
| 38 |
|
| 39 |
/** |
| 40 |
* ConfigParameter constructor. |
| 41 |
* |
| 42 |
* @param string $id |
| 43 |
* @param mixed $defaultValue |
| 44 |
*/ |
| 45 |
public function __construct($id, $defaultValue = null) |
| 46 |
{ |
| 47 |
$this->id = $id; |
| 48 |
|
| 49 |
$this->validateValue($defaultValue); |
| 50 |
$this->defaultValue = $defaultValue; |
| 51 |
} |
| 52 |
|
| 53 |
/** |
| 54 |
* Returns the id. |
| 55 |
* |
| 56 |
* @return string |
| 57 |
*/ |
| 58 |
public function getId() |
| 59 |
{ |
| 60 |
return $this->id; |
| 61 |
} |
| 62 |
|
| 63 |
/** |
| 64 |
* Checks the value type and throws an exception if the value isn't the required type. |
| 65 |
* |
| 66 |
* @param mixed $value |
| 67 |
* |
| 68 |
* @throws \Exception |
| 69 |
*/ |
| 70 |
protected function validateValue($value) |
| 71 |
{ |
| 72 |
if ($this->isValidValue($value) === false) { |
| 73 |
throw new \Exception("Wrong value '{$value}' type given for '{$this->id}'.'"); |
| 74 |
} |
| 75 |
} |
| 76 |
|
| 77 |
/** |
| 78 |
* Sets the current value. |
| 79 |
* |
| 80 |
* @param mixed $value |
| 81 |
*/ |
| 82 |
public function setValue($value) |
| 83 |
{ |
| 84 |
$this->isValidValue($value); |
| 85 |
$this->value = $value; |
| 86 |
} |
| 87 |
|
| 88 |
/** |
| 89 |
* Returns the current parameter value. |
| 90 |
* |
| 91 |
* @return mixed |
| 92 |
*/ |
| 93 |
public function getValue() |
| 94 |
{ |
| 95 |
return ($this->value === null) ? $this->defaultValue : $this->value; |
| 96 |
} |
| 97 |
} |
| 98 |
|
