vendor/symfony/config/Definition/EnumNode.php line 25

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Config\Definition;
  14. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  16. /**
  17.  * Node which only allows a finite set of values.
  18.  *
  19.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  20.  */
  21. class EnumNode extends ScalarNode
  22. {
  23.     private $values;
  25.     public function __construct(?string $name, NodeInterface $parent = null, array $values = [], string $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR)
  26.     {
  27.         $values = array_unique($values);
  28.         if (empty($values)) {
  29.             throw new \InvalidArgumentException('$values must contain at least one element.');
  30.         }
  32.         parent::__construct($name, $parent, $pathSeparator);
  33.         $this->values = $values;
  34.     }
  36.     public function getValues()
  37.     {
  38.         return $this->values;
  39.     }
  41.     /**
  42.      * {@inheritdoc}
  43.      */
  44.     protected function finalizeValue($value)
  45.     {
  46.         $value = parent::finalizeValue($value);
  48.         if (!\in_array($value, $this->values, true)) {
  49.             $ex = new InvalidConfigurationException(sprintf('The value %s is not allowed for path "%s". Permissible values: %s', json_encode($value), $this->getPath(), implode(', ', array_map('json_encode', $this->values))));
  50.             $ex->setPath($this->getPath());
  52.             throw $ex;
  53.         }
  55.         return $value;
  56.     }
  58.     /**
  59.      * {@inheritdoc}
  60.      */
  61.     protected function allowPlaceholders(): bool
  62.     {
  63.         return false;
  64.     }
  65. }