| @@ -1,29 +1,67 @@ | ||
| 1 | 1 | <?php |
| 2 | - | |
| 3 | -declare(strict_types=1); | |
| 4 | - | |
| 2 | +/** | |
| 3 | + * SelectionConfigParameter.php | |
| 4 | + * | |
| 5 | + * The SelectionConfigParameter class file. | |
| 6 | + * | |
| 7 | + * PHP versions 5 | |
| 8 | + * | |
| 9 | + * @author Alexander Schneider <[email protected]> | |
| 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 | + */ | |
| 5 | 15 | namespace UserAccessManager\Config; |
| 6 | 16 | |
| 7 | -use Exception; | |
| 8 | - | |
| 17 | +/** | |
| 18 | + * Class SelectionConfigParameter | |
| 19 | + * | |
| 20 | + * @package UserAccessManager\Config | |
| 21 | + */ | |
| 9 | 22 | class SelectionConfigParameter extends ConfigParameter |
| 10 | 23 | { |
| 11 | 24 | /** |
| 12 | - * @throws Exception | |
| 25 | + * @var array | |
| 13 | 26 | */ |
| 14 | - public function __construct(string $id, mixed $defaultValue, private array $selections) | |
| 27 | + private $selections; | |
| 28 | + | |
| 29 | + /** | |
| 30 | + * SelectionConfigParameter constructor. | |
| 31 | + * | |
| 32 | + * @param string $id | |
| 33 | + * @param mixed $defaultValue | |
| 34 | + * @param array $selections | |
| 35 | + * | |
| 36 | + * @throws \Exception | |
| 37 | + */ | |
| 38 | + public function __construct($id, $defaultValue, array $selections) | |
| 15 | 39 | { |
| 40 | + $this->selections = $selections; | |
| 41 | + | |
| 16 | 42 | parent::__construct($id, $defaultValue); |
| 17 | 43 | } |
| 18 | 44 | |
| 19 | - public function isValidValue(mixed $value): bool | |
| 45 | + /** | |
| 46 | + * Checks if the value is part of the selection. | |
| 47 | + * | |
| 48 | + * @param mixed $value | |
| 49 | + * | |
| 50 | + * @return bool | |
| 51 | + */ | |
| 52 | + public function isValidValue($value) | |
| 20 | 53 | { |
| 21 | 54 | $map = array_flip($this->selections); |
| 22 | 55 | return (isset($map[$value]) === true); |
| 23 | 56 | } |
| 24 | 57 | |
| 25 | - public function getSelections(): array | |
| 58 | + /** | |
| 59 | + * Returns the available selections. | |
| 60 | + * | |
| 61 | + * @return array | |
| 62 | + */ | |
| 63 | + public function getSelections() | |
| 26 | 64 | { |
| 27 | 65 | return $this->selections; |
| 28 | 66 | } |
| 29 | 67 | } |