12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199 |
- <?php
- 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;
- use Symfony\Component\OptionsResolver\Exception\OptionDefinitionException;
- use Symfony\Component\OptionsResolver\Exception\UndefinedOptionsException;
- class OptionsResolver implements Options
- {
-
- private $defined = [];
-
- private $defaults = [];
-
- private $nested = [];
-
- private $required = [];
-
- private $resolved = [];
-
- private $normalizers = [];
-
- private $allowedValues = [];
-
- private $allowedTypes = [];
-
- private $lazy = [];
-
- private $calling = [];
-
- private $deprecated = [];
-
- private $given = [];
-
- private $locked = false;
- private static $typeAliases = [
- 'boolean' => 'bool',
- 'integer' => 'int',
- 'double' => 'float',
- ];
-
- public function setDefault($option, $value)
- {
-
-
-
- if ($this->locked) {
- throw new AccessException('Default values cannot be set from a lazy option or normalizer.');
- }
-
-
- if ($value instanceof \Closure) {
- $reflClosure = new \ReflectionFunction($value);
- $params = $reflClosure->getParameters();
- if (isset($params[0]) && null !== ($class = $params[0]->getClass()) && Options::class === $class->name) {
-
- if (!isset($this->defaults[$option])) {
- $this->defaults[$option] = null;
- }
-
- if (!isset($this->lazy[$option]) || !isset($params[1])) {
- $this->lazy[$option] = [];
- }
-
- $this->lazy[$option][] = $value;
- $this->defined[$option] = true;
-
- unset($this->resolved[$option], $this->nested[$option]);
- return $this;
- }
- if (isset($params[0]) && null !== ($class = $params[0]->getClass()) && self::class === $class->name && (!isset($params[1]) || (null !== ($class = $params[1]->getClass()) && Options::class === $class->name))) {
-
- $this->nested[$option][] = $value;
- $this->defaults[$option] = [];
- $this->defined[$option] = true;
-
- unset($this->resolved[$option], $this->lazy[$option]);
- return $this;
- }
- }
-
- unset($this->lazy[$option], $this->nested[$option]);
-
-
-
-
- if (!isset($this->defined[$option]) || \array_key_exists($option, $this->resolved)) {
- $this->resolved[$option] = $value;
- }
- $this->defaults[$option] = $value;
- $this->defined[$option] = true;
- return $this;
- }
-
- public function setDefaults(array $defaults)
- {
- foreach ($defaults as $option => $value) {
- $this->setDefault($option, $value);
- }
- return $this;
- }
-
- public function hasDefault($option)
- {
- return \array_key_exists($option, $this->defaults);
- }
-
- public function setRequired($optionNames)
- {
- if ($this->locked) {
- throw new AccessException('Options cannot be made required from a lazy option or normalizer.');
- }
- foreach ((array) $optionNames as $option) {
- $this->defined[$option] = true;
- $this->required[$option] = true;
- }
- return $this;
- }
-
- public function isRequired($option)
- {
- return isset($this->required[$option]);
- }
-
- public function getRequiredOptions()
- {
- return array_keys($this->required);
- }
-
- public function isMissing($option)
- {
- return isset($this->required[$option]) && !\array_key_exists($option, $this->defaults);
- }
-
- public function getMissingOptions()
- {
- return array_keys(array_diff_key($this->required, $this->defaults));
- }
-
- public function setDefined($optionNames)
- {
- if ($this->locked) {
- throw new AccessException('Options cannot be defined from a lazy option or normalizer.');
- }
- foreach ((array) $optionNames as $option) {
- $this->defined[$option] = true;
- }
- return $this;
- }
-
- public function isDefined($option)
- {
- return isset($this->defined[$option]);
- }
-
- public function getDefinedOptions()
- {
- return array_keys($this->defined);
- }
- public function isNested(string $option): bool
- {
- return isset($this->nested[$option]);
- }
-
- 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".', $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)));
- }
-
- if ('' === $deprecationMessage) {
- return $this;
- }
- $this->deprecated[$option] = $deprecationMessage;
-
- unset($this->resolved[$option]);
- return $this;
- }
- public function isDeprecated(string $option): bool
- {
- return isset($this->deprecated[$option]);
- }
-
- public function setNormalizer($option, \Closure $normalizer)
- {
- 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".', $option, implode('", "', array_keys($this->defined))));
- }
- $this->normalizers[$option] = [$normalizer];
-
- unset($this->resolved[$option]);
- return $this;
- }
-
- 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".', $option, implode('", "', array_keys($this->defined))));
- }
- if ($forcePrepend) {
- array_unshift($this->normalizers[$option], $normalizer);
- } else {
- $this->normalizers[$option][] = $normalizer;
- }
-
- unset($this->resolved[$option]);
- return $this;
- }
-
- public function setAllowedValues($option, $allowedValues)
- {
- if ($this->locked) {
- throw new AccessException('Allowed values 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".', $option, implode('", "', array_keys($this->defined))));
- }
- $this->allowedValues[$option] = \is_array($allowedValues) ? $allowedValues : [$allowedValues];
-
- unset($this->resolved[$option]);
- return $this;
- }
-
- public function addAllowedValues($option, $allowedValues)
- {
- if ($this->locked) {
- throw new AccessException('Allowed values cannot be added 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".', $option, implode('", "', array_keys($this->defined))));
- }
- if (!\is_array($allowedValues)) {
- $allowedValues = [$allowedValues];
- }
- if (!isset($this->allowedValues[$option])) {
- $this->allowedValues[$option] = $allowedValues;
- } else {
- $this->allowedValues[$option] = array_merge($this->allowedValues[$option], $allowedValues);
- }
-
- unset($this->resolved[$option]);
- return $this;
- }
-
- public function setAllowedTypes($option, $allowedTypes)
- {
- if ($this->locked) {
- throw new AccessException('Allowed types 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".', $option, implode('", "', array_keys($this->defined))));
- }
- $this->allowedTypes[$option] = (array) $allowedTypes;
-
- unset($this->resolved[$option]);
- return $this;
- }
-
- public function addAllowedTypes($option, $allowedTypes)
- {
- if ($this->locked) {
- throw new AccessException('Allowed types cannot be added 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".', $option, implode('", "', array_keys($this->defined))));
- }
- if (!isset($this->allowedTypes[$option])) {
- $this->allowedTypes[$option] = (array) $allowedTypes;
- } else {
- $this->allowedTypes[$option] = array_merge($this->allowedTypes[$option], (array) $allowedTypes);
- }
-
- unset($this->resolved[$option]);
- return $this;
- }
-
- public function remove($optionNames)
- {
- if ($this->locked) {
- throw new AccessException('Options cannot be removed from a lazy option or normalizer.');
- }
- foreach ((array) $optionNames as $option) {
- unset($this->defined[$option], $this->defaults[$option], $this->required[$option], $this->resolved[$option]);
- unset($this->lazy[$option], $this->normalizers[$option], $this->allowedTypes[$option], $this->allowedValues[$option]);
- }
- return $this;
- }
-
- public function clear()
- {
- if ($this->locked) {
- throw new AccessException('Options cannot be cleared from a lazy option or normalizer.');
- }
- $this->defined = [];
- $this->defaults = [];
- $this->nested = [];
- $this->required = [];
- $this->resolved = [];
- $this->lazy = [];
- $this->normalizers = [];
- $this->allowedTypes = [];
- $this->allowedValues = [];
- $this->deprecated = [];
- return $this;
- }
-
- public function resolve(array $options = [])
- {
- if ($this->locked) {
- throw new AccessException('Options cannot be resolved from a lazy option or normalizer.');
- }
-
- $clone = clone $this;
-
- $diff = array_diff_key($options, $clone->defined);
- if (\count($diff) > 0) {
- 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))));
- }
-
- foreach ($options as $option => $value) {
- $clone->given[$option] = true;
- $clone->defaults[$option] = $value;
- unset($clone->resolved[$option], $clone->lazy[$option]);
- }
-
- $diff = array_diff_key($clone->required, $clone->defaults);
- 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))));
- }
-
- $clone->locked = true;
-
-
- foreach ($clone->defaults as $option => $_) {
- $clone->offsetGet($option);
- }
- return $clone->resolved;
- }
-
- public function offsetGet($option)
- {
- 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);
-
- 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];
- }
-
- 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 optional option "%s" has no value set. You should make sure it is set with "isset" before reading it.', $option));
- }
- $value = $this->defaults[$option];
-
- if (isset($this->nested[$option])) {
-
- if (isset($this->calling[$option])) {
- throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', implode('", "', 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".', $option, $this->formatValue($value), $this->formatTypeOf($value)));
- }
-
- $this->calling[$option] = true;
- try {
- $resolver = new self();
- foreach ($this->nested[$option] as $closure) {
- $closure($resolver, $this);
- }
- $value = $resolver->resolve($value);
- } finally {
- unset($this->calling[$option]);
- }
- }
-
- if (isset($this->lazy[$option])) {
-
-
- if (isset($this->calling[$option])) {
- throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', implode('", "', array_keys($this->calling))));
- }
-
-
-
-
- $this->calling[$option] = true;
- try {
- foreach ($this->lazy[$option] as $closure) {
- $value = $closure($this, $value);
- }
- } finally {
- unset($this->calling[$option]);
- }
-
- }
-
- if (isset($this->allowedTypes[$option])) {
- $valid = false;
- $invalidTypes = [];
- foreach ($this->allowedTypes[$option] as $type) {
- $type = self::$typeAliases[$type] ?? $type;
- if ($valid = $this->verifyTypes($type, $value, $invalidTypes)) {
- break;
- }
- }
- if (!$valid) {
- $keys = array_keys($invalidTypes);
- if (1 === \count($keys) && '[]' === substr($keys[0], -2)) {
- 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, $this->formatValue($value), implode('" or "', $this->allowedTypes[$option]), $keys[0]));
- }
- throw new InvalidOptionsException(sprintf('The option "%s" with value %s is expected to be of type "%s", but is of type "%s".', $option, $this->formatValue($value), implode('" or "', $this->allowedTypes[$option]), implode('|', array_keys($invalidTypes))));
- }
- }
-
- if (isset($this->allowedValues[$option])) {
- $success = false;
- $printableAllowedValues = [];
- foreach ($this->allowedValues[$option] as $allowedValue) {
- if ($allowedValue instanceof \Closure) {
- if ($allowedValue($value)) {
- $success = true;
- break;
- }
-
- continue;
- }
- if ($value === $allowedValue) {
- $success = true;
- break;
- }
- $printableAllowedValues[] = $allowedValue;
- }
- if (!$success) {
- $message = sprintf(
- 'The option "%s" with value %s is invalid.',
- $option,
- $this->formatValue($value)
- );
- if (\count($printableAllowedValues) > 0) {
- $message .= sprintf(
- ' Accepted values are: %s.',
- $this->formatValues($printableAllowedValues)
- );
- }
- throw new InvalidOptionsException($message);
- }
- }
-
-
- 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 (isset($this->calling[$option])) {
- throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', implode('", "', 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);
- }
- }
-
- if (isset($this->normalizers[$option])) {
-
-
- if (isset($this->calling[$option])) {
- throw new OptionDefinitionException(sprintf('The options "%s" have a cyclic dependency.', implode('", "', array_keys($this->calling))));
- }
-
-
-
-
- $this->calling[$option] = true;
- try {
- foreach ($this->normalizers[$option] as $normalizer) {
- $value = $normalizer($this, $value);
- }
- } finally {
- unset($this->calling[$option]);
- }
-
- }
-
- $this->resolved[$option] = $value;
- return $value;
- }
- private function verifyTypes(string $type, $value, array &$invalidTypes, int $level = 0): bool
- {
- if (\is_array($value) && '[]' === substr($type, -2)) {
- $type = substr($type, 0, -2);
- foreach ($value as $val) {
- if (!$this->verifyTypes($type, $val, $invalidTypes, $level + 1)) {
- return false;
- }
- }
- return true;
- }
- if (('null' === $type && null === $value) || (\function_exists($func = 'is_'.$type) && $func($value)) || $value instanceof $type) {
- return true;
- }
- if (!$invalidTypes) {
- $suffix = '';
- while (\strlen($suffix) < $level * 2) {
- $suffix .= '[]';
- }
- $invalidTypes[$this->formatTypeOf($value).$suffix] = true;
- }
- return false;
- }
-
- public function offsetExists($option)
- {
- if (!$this->locked) {
- throw new AccessException('Array access is only supported within closures of lazy options and normalizers.');
- }
- return \array_key_exists($option, $this->defaults);
- }
-
- public function offsetSet($option, $value)
- {
- throw new AccessException('Setting options via array access is not supported. Use setDefault() instead.');
- }
-
- public function offsetUnset($option)
- {
- throw new AccessException('Removing options via array access is not supported. Use remove() instead.');
- }
-
- public function count()
- {
- if (!$this->locked) {
- throw new AccessException('Counting is only supported within closures of lazy options and normalizers.');
- }
- return \count($this->defaults);
- }
-
- private function formatTypeOf($value): string
- {
- return \is_object($value) ? \get_class($value) : \gettype($value);
- }
-
- private function formatValue($value): string
- {
- if (\is_object($value)) {
- return \get_class($value);
- }
- if (\is_array($value)) {
- return 'array';
- }
- if (\is_string($value)) {
- return '"'.$value.'"';
- }
- if (\is_resource($value)) {
- return 'resource';
- }
- if (null === $value) {
- return 'null';
- }
- if (false === $value) {
- return 'false';
- }
- if (true === $value) {
- return 'true';
- }
- return (string) $value;
- }
-
- private function formatValues(array $values): string
- {
- foreach ($values as $key => $value) {
- $values[$key] = $this->formatValue($value);
- }
- return implode(', ', $values);
- }
- }
|