update
This commit is contained in:
@@ -12,6 +12,7 @@
|
||||
namespace Symfony\Component\OptionsResolver;
|
||||
|
||||
use Symfony\Component\OptionsResolver\Exception\AccessException;
|
||||
use Symfony\Component\OptionsResolver\Exception\InvalidArgumentException;
|
||||
use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
|
||||
use Symfony\Component\OptionsResolver\Exception\MissingOptionsException;
|
||||
use Symfony\Component\OptionsResolver\Exception\NoSuchOptionException;
|
||||
@@ -36,6 +37,13 @@ class OptionsResolver implements Options
|
||||
*/
|
||||
private $defaults = [];
|
||||
|
||||
/**
|
||||
* A list of closure for nested options.
|
||||
*
|
||||
* @var \Closure[][]
|
||||
*/
|
||||
private $nested = [];
|
||||
|
||||
/**
|
||||
* The names of required options.
|
||||
*/
|
||||
@@ -49,7 +57,7 @@ class OptionsResolver implements Options
|
||||
/**
|
||||
* A list of normalizer closures.
|
||||
*
|
||||
* @var \Closure[]
|
||||
* @var \Closure[][]
|
||||
*/
|
||||
private $normalizers = [];
|
||||
|
||||
@@ -75,6 +83,16 @@ class OptionsResolver implements Options
|
||||
*/
|
||||
private $calling = [];
|
||||
|
||||
/**
|
||||
* A list of deprecated options.
|
||||
*/
|
||||
private $deprecated = [];
|
||||
|
||||
/**
|
||||
* The list of options provided by the user.
|
||||
*/
|
||||
private $given = [];
|
||||
|
||||
/**
|
||||
* Whether the instance is locked for reading.
|
||||
*
|
||||
@@ -85,7 +103,9 @@ class OptionsResolver implements Options
|
||||
*/
|
||||
private $locked = false;
|
||||
|
||||
private static $typeAliases = [
|
||||
private $parentsOptions = [];
|
||||
|
||||
private const TYPE_ALIASES = [
|
||||
'boolean' => 'bool',
|
||||
'integer' => 'int',
|
||||
'double' => 'float',
|
||||
@@ -124,6 +144,20 @@ class OptionsResolver implements Options
|
||||
* is spread across different locations of your code, such as base and
|
||||
* sub-classes.
|
||||
*
|
||||
* If you want to define nested options, you can pass a closure with the
|
||||
* following signature:
|
||||
*
|
||||
* $options->setDefault('database', function (OptionsResolver $resolver) {
|
||||
* $resolver->setDefined(['dbname', 'host', 'port', 'user', 'pass']);
|
||||
* }
|
||||
*
|
||||
* To get access to the parent options, add a second argument to the closure's
|
||||
* signature:
|
||||
*
|
||||
* function (OptionsResolver $resolver, Options $parent) {
|
||||
* // 'default' === $parent['connection']
|
||||
* }
|
||||
*
|
||||
* @param string $option The name of the option
|
||||
* @param mixed $value The default value of the option
|
||||
*
|
||||
@@ -161,15 +195,27 @@ class OptionsResolver implements Options
|
||||
$this->lazy[$option][] = $value;
|
||||
$this->defined[$option] = true;
|
||||
|
||||
// Make sure the option is processed
|
||||
unset($this->resolved[$option]);
|
||||
// Make sure the option is processed and is not nested anymore
|
||||
unset($this->resolved[$option], $this->nested[$option]);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
if (isset($params[0]) && null !== ($type = $params[0]->getType()) && self::class === $type->getName() && (!isset($params[1]) || (($type = $params[1]->getType()) instanceof \ReflectionNamedType && Options::class === $type->getName()))) {
|
||||
// Store closure for later evaluation
|
||||
$this->nested[$option][] = $value;
|
||||
$this->defaults[$option] = [];
|
||||
$this->defined[$option] = true;
|
||||
|
||||
// Make sure the option is processed and is not lazy anymore
|
||||
unset($this->resolved[$option], $this->lazy[$option]);
|
||||
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
|
||||
// This option is not lazy anymore
|
||||
unset($this->lazy[$option]);
|
||||
// This option is not lazy nor nested anymore
|
||||
unset($this->lazy[$option], $this->nested[$option]);
|
||||
|
||||
// Yet undefined options can be marked as resolved, because we only need
|
||||
// to resolve options with lazy closures, normalizers or validation
|
||||
@@ -186,10 +232,6 @@ class OptionsResolver implements Options
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a list of default values.
|
||||
*
|
||||
* @param array $defaults The default values to set
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @throws AccessException If called from a lazy option or normalizer
|
||||
@@ -348,6 +390,62 @@ class OptionsResolver implements Options
|
||||
return array_keys($this->defined);
|
||||
}
|
||||
|
||||
public function isNested(string $option): bool
|
||||
{
|
||||
return isset($this->nested[$option]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deprecates an option, allowed types or values.
|
||||
*
|
||||
* Instead of passing the message, you may also pass a closure with the
|
||||
* following signature:
|
||||
*
|
||||
* function (Options $options, $value): string {
|
||||
* // ...
|
||||
* }
|
||||
*
|
||||
* The closure receives the value as argument and should return a string.
|
||||
* Return an empty string to ignore the option deprecation.
|
||||
*
|
||||
* The closure is invoked when {@link resolve()} is called. The parameter
|
||||
* passed to the closure is the value of the option after validating it
|
||||
* and before normalizing it.
|
||||
*
|
||||
* @param string|\Closure $deprecationMessage
|
||||
*/
|
||||
public function setDeprecated(string $option, $deprecationMessage = 'The option "%name%" is deprecated.'): self
|
||||
{
|
||||
if ($this->locked) {
|
||||
throw new AccessException('Options cannot be deprecated from a lazy option or normalizer.');
|
||||
}
|
||||
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist, defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
if (!\is_string($deprecationMessage) && !$deprecationMessage instanceof \Closure) {
|
||||
throw new InvalidArgumentException(sprintf('Invalid type for deprecation message argument, expected string or \Closure, but got "%s".', \gettype($deprecationMessage)));
|
||||
}
|
||||
|
||||
// ignore if empty string
|
||||
if ('' === $deprecationMessage) {
|
||||
return $this;
|
||||
}
|
||||
|
||||
$this->deprecated[$option] = $deprecationMessage;
|
||||
|
||||
// Make sure the option is processed
|
||||
unset($this->resolved[$option]);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function isDeprecated(string $option): bool
|
||||
{
|
||||
return isset($this->deprecated[$option]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the normalizer for an option.
|
||||
*
|
||||
@@ -366,8 +464,7 @@ class OptionsResolver implements Options
|
||||
*
|
||||
* The resolved option value is set to the return value of the closure.
|
||||
*
|
||||
* @param string $option The option name
|
||||
* @param \Closure $normalizer The normalizer
|
||||
* @param string $option The option name
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
@@ -381,10 +478,56 @@ class OptionsResolver implements Options
|
||||
}
|
||||
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $option, implode('", "', array_keys($this->defined))));
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
$this->normalizers[$option] = $normalizer;
|
||||
$this->normalizers[$option] = [$normalizer];
|
||||
|
||||
// Make sure the option is processed
|
||||
unset($this->resolved[$option]);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a normalizer for an option.
|
||||
*
|
||||
* The normalizer should be a closure with the following signature:
|
||||
*
|
||||
* function (Options $options, $value): mixed {
|
||||
* // ...
|
||||
* }
|
||||
*
|
||||
* The closure is invoked when {@link resolve()} is called. The closure
|
||||
* has access to the resolved values of other options through the passed
|
||||
* {@link Options} instance.
|
||||
*
|
||||
* The second parameter passed to the closure is the value of
|
||||
* the option.
|
||||
*
|
||||
* The resolved option value is set to the return value of the closure.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @throws UndefinedOptionsException If the option is undefined
|
||||
* @throws AccessException If called from a lazy option or normalizer
|
||||
*/
|
||||
public function addNormalizer(string $option, \Closure $normalizer, bool $forcePrepend = false): self
|
||||
{
|
||||
if ($this->locked) {
|
||||
throw new AccessException('Normalizers cannot be set from a lazy option or normalizer.');
|
||||
}
|
||||
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
if ($forcePrepend) {
|
||||
$this->normalizers[$option] = $this->normalizers[$option] ?? [];
|
||||
array_unshift($this->normalizers[$option], $normalizer);
|
||||
} else {
|
||||
$this->normalizers[$option][] = $normalizer;
|
||||
}
|
||||
|
||||
// Make sure the option is processed
|
||||
unset($this->resolved[$option]);
|
||||
@@ -420,7 +563,7 @@ class OptionsResolver implements Options
|
||||
}
|
||||
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $option, implode('", "', array_keys($this->defined))));
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
$this->allowedValues[$option] = \is_array($allowedValues) ? $allowedValues : [$allowedValues];
|
||||
@@ -461,7 +604,7 @@ class OptionsResolver implements Options
|
||||
}
|
||||
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $option, implode('", "', array_keys($this->defined))));
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
if (!\is_array($allowedValues)) {
|
||||
@@ -502,7 +645,7 @@ class OptionsResolver implements Options
|
||||
}
|
||||
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $option, implode('", "', array_keys($this->defined))));
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
$this->allowedTypes[$option] = (array) $allowedTypes;
|
||||
@@ -537,7 +680,7 @@ class OptionsResolver implements Options
|
||||
}
|
||||
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $option, implode('", "', array_keys($this->defined))));
|
||||
throw new UndefinedOptionsException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
if (!isset($this->allowedTypes[$option])) {
|
||||
@@ -592,12 +735,14 @@ class OptionsResolver implements Options
|
||||
|
||||
$this->defined = [];
|
||||
$this->defaults = [];
|
||||
$this->nested = [];
|
||||
$this->required = [];
|
||||
$this->resolved = [];
|
||||
$this->lazy = [];
|
||||
$this->normalizers = [];
|
||||
$this->allowedTypes = [];
|
||||
$this->allowedValues = [];
|
||||
$this->deprecated = [];
|
||||
|
||||
return $this;
|
||||
}
|
||||
@@ -613,8 +758,6 @@ class OptionsResolver implements Options
|
||||
* - Options have invalid types;
|
||||
* - Options have invalid values.
|
||||
*
|
||||
* @param array $options A map of option names to values
|
||||
*
|
||||
* @return array The merged and validated options
|
||||
*
|
||||
* @throws UndefinedOptionsException If an option name is undefined
|
||||
@@ -642,11 +785,12 @@ class OptionsResolver implements Options
|
||||
ksort($clone->defined);
|
||||
ksort($diff);
|
||||
|
||||
throw new UndefinedOptionsException(sprintf((\count($diff) > 1 ? 'The options "%s" do not exist.' : 'The option "%s" does not exist.').' Defined options are: "%s".', implode('", "', array_keys($diff)), implode('", "', array_keys($clone->defined))));
|
||||
throw new UndefinedOptionsException(sprintf((\count($diff) > 1 ? 'The options "%s" do not exist.' : 'The option "%s" does not exist.').' Defined options are: "%s".', $this->formatOptions(array_keys($diff)), implode('", "', array_keys($clone->defined))));
|
||||
}
|
||||
|
||||
// Override options set by the user
|
||||
foreach ($options as $option => $value) {
|
||||
$clone->given[$option] = true;
|
||||
$clone->defaults[$option] = $value;
|
||||
unset($clone->resolved[$option], $clone->lazy[$option]);
|
||||
}
|
||||
@@ -657,7 +801,7 @@ class OptionsResolver implements Options
|
||||
if (\count($diff) > 0) {
|
||||
ksort($diff);
|
||||
|
||||
throw new MissingOptionsException(sprintf(\count($diff) > 1 ? 'The required options "%s" are missing.' : 'The required option "%s" is missing.', implode('", "', array_keys($diff))));
|
||||
throw new MissingOptionsException(sprintf(\count($diff) > 1 ? 'The required options "%s" are missing.' : 'The required option "%s" is missing.', $this->formatOptions(array_keys($diff))));
|
||||
}
|
||||
|
||||
// Lock the container
|
||||
@@ -675,7 +819,8 @@ class OptionsResolver implements Options
|
||||
/**
|
||||
* Returns the resolved value of an option.
|
||||
*
|
||||
* @param string $option The option name
|
||||
* @param string $option The option name
|
||||
* @param bool $triggerDeprecation Whether to trigger the deprecation or not (true by default)
|
||||
*
|
||||
* @return mixed The option value
|
||||
*
|
||||
@@ -687,34 +832,67 @@ class OptionsResolver implements Options
|
||||
* @throws OptionDefinitionException If there is a cyclic dependency between
|
||||
* lazy options and/or normalizers
|
||||
*/
|
||||
public function offsetGet($option)
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetGet($option/* , bool $triggerDeprecation = true */)
|
||||
{
|
||||
if (!$this->locked) {
|
||||
throw new AccessException('Array access is only supported within closures of lazy options and normalizers.');
|
||||
}
|
||||
|
||||
$triggerDeprecation = 1 === \func_num_args() || func_get_arg(1);
|
||||
|
||||
// Shortcut for resolved options
|
||||
if (\array_key_exists($option, $this->resolved)) {
|
||||
if (isset($this->resolved[$option]) || \array_key_exists($option, $this->resolved)) {
|
||||
if ($triggerDeprecation && isset($this->deprecated[$option]) && (isset($this->given[$option]) || $this->calling) && \is_string($this->deprecated[$option])) {
|
||||
@trigger_error(strtr($this->deprecated[$option], ['%name%' => $option]), \E_USER_DEPRECATED);
|
||||
}
|
||||
|
||||
return $this->resolved[$option];
|
||||
}
|
||||
|
||||
// Check whether the option is set at all
|
||||
if (!\array_key_exists($option, $this->defaults)) {
|
||||
if (!isset($this->defaults[$option]) && !\array_key_exists($option, $this->defaults)) {
|
||||
if (!isset($this->defined[$option])) {
|
||||
throw new NoSuchOptionException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $option, implode('", "', array_keys($this->defined))));
|
||||
throw new NoSuchOptionException(sprintf('The option "%s" does not exist. Defined options are: "%s".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
|
||||
}
|
||||
|
||||
throw new NoSuchOptionException(sprintf('The optional option "%s" has no value set. You should make sure it is set with "isset" before reading it.', $option));
|
||||
throw new NoSuchOptionException(sprintf('The optional option "%s" has no value set. You should make sure it is set with "isset" before reading it.', $this->formatOptions([$option])));
|
||||
}
|
||||
|
||||
$value = $this->defaults[$option];
|
||||
|
||||
// Resolve the option if it is a nested definition
|
||||
if (isset($this->nested[$option])) {
|
||||
// If the closure is already being called, we have a cyclic dependency
|
||||
if (isset($this->calling[$option])) {
|
||||
throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', $this->formatOptions(array_keys($this->calling))));
|
||||
}
|
||||
|
||||
if (!\is_array($value)) {
|
||||
throw new InvalidOptionsException(sprintf('The nested option "%s" with value %s is expected to be of type array, but is of type "%s".', $this->formatOptions([$option]), $this->formatValue($value), $this->formatTypeOf($value)));
|
||||
}
|
||||
|
||||
// The following section must be protected from cyclic calls.
|
||||
$this->calling[$option] = true;
|
||||
try {
|
||||
$resolver = new self();
|
||||
$resolver->parentsOptions = $this->parentsOptions;
|
||||
$resolver->parentsOptions[] = $option;
|
||||
foreach ($this->nested[$option] as $closure) {
|
||||
$closure($resolver, $this);
|
||||
}
|
||||
$value = $resolver->resolve($value);
|
||||
} finally {
|
||||
unset($this->calling[$option]);
|
||||
}
|
||||
}
|
||||
|
||||
// Resolve the option if the default value is lazily evaluated
|
||||
if (isset($this->lazy[$option])) {
|
||||
// If the closure is already being called, we have a cyclic
|
||||
// dependency
|
||||
if (isset($this->calling[$option])) {
|
||||
throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', implode('", "', array_keys($this->calling))));
|
||||
throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', $this->formatOptions(array_keys($this->calling))));
|
||||
}
|
||||
|
||||
// The following section must be protected from cyclic
|
||||
@@ -738,7 +916,7 @@ class OptionsResolver implements Options
|
||||
$invalidTypes = [];
|
||||
|
||||
foreach ($this->allowedTypes[$option] as $type) {
|
||||
$type = isset(self::$typeAliases[$type]) ? self::$typeAliases[$type] : $type;
|
||||
$type = self::TYPE_ALIASES[$type] ?? $type;
|
||||
|
||||
if ($valid = $this->verifyTypes($type, $value, $invalidTypes)) {
|
||||
break;
|
||||
@@ -749,19 +927,15 @@ class OptionsResolver implements Options
|
||||
$fmtActualValue = $this->formatValue($value);
|
||||
$fmtAllowedTypes = implode('" or "', $this->allowedTypes[$option]);
|
||||
$fmtProvidedTypes = implode('|', array_keys($invalidTypes));
|
||||
|
||||
$allowedContainsArrayType = \count(array_filter(
|
||||
$this->allowedTypes[$option],
|
||||
function ($item) {
|
||||
return '[]' === substr(isset(self::$typeAliases[$item]) ? self::$typeAliases[$item] : $item, -2);
|
||||
}
|
||||
)) > 0;
|
||||
$allowedContainsArrayType = \count(array_filter($this->allowedTypes[$option], static function ($item) {
|
||||
return str_ends_with(self::TYPE_ALIASES[$item] ?? $item, '[]');
|
||||
})) > 0;
|
||||
|
||||
if (\is_array($value) && $allowedContainsArrayType) {
|
||||
throw new InvalidOptionsException(sprintf('The option "%s" with value %s is expected to be of type "%s", but one of the elements is of type "%s".', $option, $fmtActualValue, $fmtAllowedTypes, $fmtProvidedTypes));
|
||||
throw new InvalidOptionsException(sprintf('The option "%s" with value %s is expected to be of type "%s", but one of the elements is of type "%s".', $this->formatOptions([$option]), $fmtActualValue, $fmtAllowedTypes, $fmtProvidedTypes));
|
||||
}
|
||||
|
||||
throw new InvalidOptionsException(sprintf('The option "%s" with value %s is expected to be of type "%s", but is of type "%s".', $option, $fmtActualValue, $fmtAllowedTypes, $fmtProvidedTypes));
|
||||
throw new InvalidOptionsException(sprintf('The option "%s" with value %s is expected to be of type "%s", but is of type "%s".', $this->formatOptions([$option]), $fmtActualValue, $fmtAllowedTypes, $fmtProvidedTypes));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -807,23 +981,49 @@ class OptionsResolver implements Options
|
||||
}
|
||||
}
|
||||
|
||||
// Check whether the option is deprecated
|
||||
// and it is provided by the user or is being called from a lazy evaluation
|
||||
if ($triggerDeprecation && isset($this->deprecated[$option]) && (isset($this->given[$option]) || ($this->calling && \is_string($this->deprecated[$option])))) {
|
||||
$deprecationMessage = $this->deprecated[$option];
|
||||
|
||||
if ($deprecationMessage instanceof \Closure) {
|
||||
// If the closure is already being called, we have a cyclic dependency
|
||||
if (isset($this->calling[$option])) {
|
||||
throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', $this->formatOptions(array_keys($this->calling))));
|
||||
}
|
||||
|
||||
$this->calling[$option] = true;
|
||||
try {
|
||||
if (!\is_string($deprecationMessage = $deprecationMessage($this, $value))) {
|
||||
throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", return an empty string to ignore.', \gettype($deprecationMessage)));
|
||||
}
|
||||
} finally {
|
||||
unset($this->calling[$option]);
|
||||
}
|
||||
}
|
||||
|
||||
if ('' !== $deprecationMessage) {
|
||||
@trigger_error(strtr($deprecationMessage, ['%name%' => $option]), \E_USER_DEPRECATED);
|
||||
}
|
||||
}
|
||||
|
||||
// Normalize the validated option
|
||||
if (isset($this->normalizers[$option])) {
|
||||
// If the closure is already being called, we have a cyclic
|
||||
// dependency
|
||||
if (isset($this->calling[$option])) {
|
||||
throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', implode('", "', array_keys($this->calling))));
|
||||
throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', $this->formatOptions(array_keys($this->calling))));
|
||||
}
|
||||
|
||||
$normalizer = $this->normalizers[$option];
|
||||
|
||||
// The following section must be protected from cyclic
|
||||
// calls. Set $calling for the current $option to detect a cyclic
|
||||
// dependency
|
||||
// BEGIN
|
||||
$this->calling[$option] = true;
|
||||
try {
|
||||
$value = $normalizer($this, $value);
|
||||
foreach ($this->normalizers[$option] as $normalizer) {
|
||||
$value = $normalizer($this, $value);
|
||||
}
|
||||
} finally {
|
||||
unset($this->calling[$option]);
|
||||
}
|
||||
@@ -836,63 +1036,30 @@ class OptionsResolver implements Options
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $type
|
||||
* @param mixed $value
|
||||
* @param array &$invalidTypes
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function verifyTypes($type, $value, array &$invalidTypes)
|
||||
private function verifyTypes(string $type, $value, array &$invalidTypes, int $level = 0): bool
|
||||
{
|
||||
if (\is_array($value) && '[]' === substr($type, -2)) {
|
||||
return $this->verifyArrayType($type, $value, $invalidTypes);
|
||||
}
|
||||
$type = substr($type, 0, -2);
|
||||
$valid = true;
|
||||
|
||||
if (self::isValueValidType($type, $value)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (!$invalidTypes) {
|
||||
$invalidTypes[$this->formatTypeOf($value, null)] = true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
private function verifyArrayType($type, array $value, array &$invalidTypes, $level = 0)
|
||||
{
|
||||
$type = substr($type, 0, -2);
|
||||
|
||||
if ('[]' === substr($type, -2)) {
|
||||
$success = true;
|
||||
foreach ($value as $item) {
|
||||
if (!\is_array($item)) {
|
||||
$invalidTypes[$this->formatTypeOf($item, null)] = true;
|
||||
|
||||
$success = false;
|
||||
} elseif (!$this->verifyArrayType($type, $item, $invalidTypes, $level + 1)) {
|
||||
$success = false;
|
||||
foreach ($value as $val) {
|
||||
if (!$this->verifyTypes($type, $val, $invalidTypes, $level + 1)) {
|
||||
$valid = false;
|
||||
}
|
||||
}
|
||||
|
||||
return $success;
|
||||
return $valid;
|
||||
}
|
||||
|
||||
$valid = true;
|
||||
|
||||
foreach ($value as $item) {
|
||||
if (!self::isValueValidType($type, $item)) {
|
||||
$invalidTypes[$this->formatTypeOf($item, $type)] = $value;
|
||||
|
||||
$valid = false;
|
||||
}
|
||||
if (('null' === $type && null === $value) || (\function_exists($func = 'is_'.$type) && $func($value)) || $value instanceof $type) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $valid;
|
||||
if (!$invalidTypes || $level > 0) {
|
||||
$invalidTypes[$this->formatTypeOf($value)] = true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -906,6 +1073,7 @@ class OptionsResolver implements Options
|
||||
*
|
||||
* @see \ArrayAccess::offsetExists()
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetExists($option)
|
||||
{
|
||||
if (!$this->locked) {
|
||||
@@ -918,8 +1086,11 @@ class OptionsResolver implements Options
|
||||
/**
|
||||
* Not supported.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws AccessException
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetSet($option, $value)
|
||||
{
|
||||
throw new AccessException('Setting options via array access is not supported. Use setDefault() instead.');
|
||||
@@ -928,8 +1099,11 @@ class OptionsResolver implements Options
|
||||
/**
|
||||
* Not supported.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws AccessException
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetUnset($option)
|
||||
{
|
||||
throw new AccessException('Removing options via array access is not supported. Use remove() instead.');
|
||||
@@ -946,6 +1120,7 @@ class OptionsResolver implements Options
|
||||
*
|
||||
* @see \Countable::count()
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function count()
|
||||
{
|
||||
if (!$this->locked) {
|
||||
@@ -958,43 +1133,13 @@ class OptionsResolver implements Options
|
||||
/**
|
||||
* Returns a string representation of the type of the value.
|
||||
*
|
||||
* This method should be used if you pass the type of a value as
|
||||
* message parameter to a constraint violation. Note that such
|
||||
* parameters should usually not be included in messages aimed at
|
||||
* non-technical people.
|
||||
*
|
||||
* @param mixed $value The value to return the type of
|
||||
* @param string $type
|
||||
* @param mixed $value The value to return the type of
|
||||
*
|
||||
* @return string The type of the value
|
||||
*/
|
||||
private function formatTypeOf($value, $type)
|
||||
private function formatTypeOf($value): string
|
||||
{
|
||||
$suffix = '';
|
||||
|
||||
if ('[]' === substr($type, -2)) {
|
||||
$suffix = '[]';
|
||||
$type = substr($type, 0, -2);
|
||||
while ('[]' === substr($type, -2)) {
|
||||
$type = substr($type, 0, -2);
|
||||
$value = array_shift($value);
|
||||
if (!\is_array($value)) {
|
||||
break;
|
||||
}
|
||||
$suffix .= '[]';
|
||||
}
|
||||
|
||||
if (\is_array($value)) {
|
||||
$subTypes = [];
|
||||
foreach ($value as $val) {
|
||||
$subTypes[$this->formatTypeOf($val, null)] = true;
|
||||
}
|
||||
|
||||
return implode('|', array_keys($subTypes)).$suffix;
|
||||
}
|
||||
}
|
||||
|
||||
return (\is_object($value) ? \get_class($value) : \gettype($value)).$suffix;
|
||||
return \is_object($value) ? \get_class($value) : \gettype($value);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1005,10 +1150,8 @@ class OptionsResolver implements Options
|
||||
* in double quotes (").
|
||||
*
|
||||
* @param mixed $value The value to format as string
|
||||
*
|
||||
* @return string The string representation of the passed value
|
||||
*/
|
||||
private function formatValue($value)
|
||||
private function formatValue($value): string
|
||||
{
|
||||
if (\is_object($value)) {
|
||||
return \get_class($value);
|
||||
@@ -1047,13 +1190,9 @@ class OptionsResolver implements Options
|
||||
* Each of the values is converted to a string using
|
||||
* {@link formatValue()}. The values are then concatenated with commas.
|
||||
*
|
||||
* @param array $values A list of values
|
||||
*
|
||||
* @return string The string representation of the value list
|
||||
*
|
||||
* @see formatValue()
|
||||
*/
|
||||
private function formatValues(array $values)
|
||||
private function formatValues(array $values): string
|
||||
{
|
||||
foreach ($values as $key => $value) {
|
||||
$values[$key] = $this->formatValue($value);
|
||||
@@ -1062,24 +1201,28 @@ class OptionsResolver implements Options
|
||||
return implode(', ', $values);
|
||||
}
|
||||
|
||||
private static function isValueValidType($type, $value)
|
||||
private function formatOptions(array $options): string
|
||||
{
|
||||
return (\function_exists($isFunction = 'is_'.$type) && $isFunction($value)) || $value instanceof $type;
|
||||
}
|
||||
if ($this->parentsOptions) {
|
||||
$prefix = array_shift($this->parentsOptions);
|
||||
if ($this->parentsOptions) {
|
||||
$prefix .= sprintf('[%s]', implode('][', $this->parentsOptions));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string|null
|
||||
*/
|
||||
private function getParameterClassName(\ReflectionParameter $parameter)
|
||||
{
|
||||
if (!method_exists($parameter, 'getType')) {
|
||||
return ($class = $parameter->getClass()) ? $class->name : null;
|
||||
$options = array_map(static function (string $option) use ($prefix): string {
|
||||
return sprintf('%s[%s]', $prefix, $option);
|
||||
}, $options);
|
||||
}
|
||||
|
||||
if (!($type = $parameter->getType()) || $type->isBuiltin()) {
|
||||
return implode('", "', $options);
|
||||
}
|
||||
|
||||
private function getParameterClassName(\ReflectionParameter $parameter): ?string
|
||||
{
|
||||
if (!($type = $parameter->getType()) instanceof \ReflectionNamedType || $type->isBuiltin()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return $type instanceof \ReflectionNamedType ? $type->getName() : (string) $type;
|
||||
return $type->getName();
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user