91 lines
2.6 KiB
PHP
91 lines
2.6 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Config\Definition;
|
|
|
|
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
|
|
|
|
/**
|
|
* Node which only allows a finite set of values.
|
|
*
|
|
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
|
|
*/
|
|
class EnumNode extends ScalarNode
|
|
{
|
|
private array $values;
|
|
|
|
public function __construct(?string $name, ?NodeInterface $parent = null, array $values = [], string $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR)
|
|
{
|
|
if (!$values) {
|
|
throw new \InvalidArgumentException('$values must contain at least one element.');
|
|
}
|
|
|
|
foreach ($values as $value) {
|
|
if (null === $value || \is_scalar($value)) {
|
|
continue;
|
|
}
|
|
|
|
if (!$value instanceof \UnitEnum) {
|
|
throw new \InvalidArgumentException(sprintf('"%s" only supports scalar, enum, or null values, "%s" given.', __CLASS__, get_debug_type($value)));
|
|
}
|
|
|
|
if ($value::class !== ($enumClass ??= $value::class)) {
|
|
throw new \InvalidArgumentException(sprintf('"%s" only supports one type of enum, "%s" and "%s" passed.', __CLASS__, $enumClass, $value::class));
|
|
}
|
|
}
|
|
|
|
parent::__construct($name, $parent, $pathSeparator);
|
|
$this->values = $values;
|
|
}
|
|
|
|
public function getValues(): array
|
|
{
|
|
return $this->values;
|
|
}
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
public function getPermissibleValues(string $separator): string
|
|
{
|
|
return implode($separator, array_unique(array_map(static function (mixed $value): string {
|
|
if (!$value instanceof \UnitEnum) {
|
|
return json_encode($value);
|
|
}
|
|
|
|
return ltrim(var_export($value, true), '\\');
|
|
}, $this->values)));
|
|
}
|
|
|
|
protected function validateType(mixed $value): void
|
|
{
|
|
if ($value instanceof \UnitEnum) {
|
|
return;
|
|
}
|
|
|
|
parent::validateType($value);
|
|
}
|
|
|
|
protected function finalizeValue(mixed $value): mixed
|
|
{
|
|
$value = parent::finalizeValue($value);
|
|
|
|
if (!\in_array($value, $this->values, true)) {
|
|
$ex = new InvalidConfigurationException(sprintf('The value %s is not allowed for path "%s". Permissible values: %s', json_encode($value), $this->getPath(), $this->getPermissibleValues(', ')));
|
|
$ex->setPath($this->getPath());
|
|
|
|
throw $ex;
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
}
|