12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292 |
- <?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\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;
- /**
- * Validates options and merges them with default values.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- * @author Tobias Schultze <http://tobion.de>
- */
- class OptionsResolver implements Options
- {
- /**
- * The names of all defined options.
- */
- private $defined = [];
- /**
- * The default option values.
- */
- private $defaults = [];
- /**
- * A list of closure for nested options.
- *
- * @var \Closure[][]
- */
- private $nested = [];
- /**
- * The names of required options.
- */
- private $required = [];
- /**
- * The resolved option values.
- */
- private $resolved = [];
- /**
- * A list of normalizer closures.
- *
- * @var \Closure[][]
- */
- private $normalizers = [];
- /**
- * A list of accepted values for each option.
- */
- private $allowedValues = [];
- /**
- * A list of accepted types for each option.
- */
- private $allowedTypes = [];
- /**
- * A list of info messages for each option.
- */
- private $info = [];
- /**
- * A list of closures for evaluating lazy options.
- */
- private $lazy = [];
- /**
- * A list of lazy options whose closure is currently being called.
- *
- * This list helps detecting circular dependencies between lazy 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.
- *
- * Once locked, the options cannot be changed anymore. This is
- * necessary in order to avoid inconsistencies during the resolving
- * process. If any option is changed after being read, all evaluated
- * lazy options that depend on this option would become invalid.
- */
- private $locked = false;
- private $parentsOptions = [];
- private static $typeAliases = [
- 'boolean' => 'bool',
- 'integer' => 'int',
- 'double' => 'float',
- ];
- /**
- * Sets the default value of a given option.
- *
- * If the default value should be set based on other options, you can pass
- * a closure with the following signature:
- *
- * function (Options $options) {
- * // ...
- * }
- *
- * The closure will be evaluated when {@link resolve()} is called. The
- * closure has access to the resolved values of other options through the
- * passed {@link Options} instance:
- *
- * function (Options $options) {
- * if (isset($options['port'])) {
- * // ...
- * }
- * }
- *
- * If you want to access the previously set default value, add a second
- * argument to the closure's signature:
- *
- * $options->setDefault('name', 'Default Name');
- *
- * $options->setDefault('name', function (Options $options, $previousValue) {
- * // 'Default Name' === $previousValue
- * });
- *
- * This is mostly useful if the configuration of the {@link Options} object
- * 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
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function setDefault(string $option, $value)
- {
- // Setting is not possible once resolving starts, because then lazy
- // options could manipulate the state of the object, leading to
- // inconsistent results.
- if ($this->locked) {
- throw new AccessException('Default values cannot be set from a lazy option or normalizer.');
- }
- // If an option is a closure that should be evaluated lazily, store it
- // in the "lazy" property.
- if ($value instanceof \Closure) {
- $reflClosure = new \ReflectionFunction($value);
- $params = $reflClosure->getParameters();
- if (isset($params[0]) && Options::class === $this->getParameterClassName($params[0])) {
- // Initialize the option if no previous value exists
- if (!isset($this->defaults[$option])) {
- $this->defaults[$option] = null;
- }
- // Ignore previous lazy options if the closure has no second parameter
- if (!isset($this->lazy[$option]) || !isset($params[1])) {
- $this->lazy[$option] = [];
- }
- // Store closure for later evaluation
- $this->lazy[$option][] = $value;
- $this->defined[$option] = true;
- // 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]) || (null !== ($type = $params[1]->getType()) && 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 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
- // rules, none of which can exist for undefined options
- // If the option was resolved before, update the resolved value
- 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;
- }
- /**
- * 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
- */
- public function setDefaults(array $defaults)
- {
- foreach ($defaults as $option => $value) {
- $this->setDefault($option, $value);
- }
- return $this;
- }
- /**
- * Returns whether a default value is set for an option.
- *
- * Returns true if {@link setDefault()} was called for this option.
- * An option is also considered set if it was set to null.
- *
- * @param string $option The option name
- *
- * @return bool Whether a default value is set
- */
- public function hasDefault(string $option)
- {
- return \array_key_exists($option, $this->defaults);
- }
- /**
- * Marks one or more options as required.
- *
- * @param string|string[] $optionNames One or more option names
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- 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;
- }
- /**
- * Returns whether an option is required.
- *
- * An option is required if it was passed to {@link setRequired()}.
- *
- * @param string $option The name of the option
- *
- * @return bool Whether the option is required
- */
- public function isRequired(string $option)
- {
- return isset($this->required[$option]);
- }
- /**
- * Returns the names of all required options.
- *
- * @return string[] The names of the required options
- *
- * @see isRequired()
- */
- public function getRequiredOptions()
- {
- return array_keys($this->required);
- }
- /**
- * Returns whether an option is missing a default value.
- *
- * An option is missing if it was passed to {@link setRequired()}, but not
- * to {@link setDefault()}. This option must be passed explicitly to
- * {@link resolve()}, otherwise an exception will be thrown.
- *
- * @param string $option The name of the option
- *
- * @return bool Whether the option is missing
- */
- public function isMissing(string $option)
- {
- return isset($this->required[$option]) && !\array_key_exists($option, $this->defaults);
- }
- /**
- * Returns the names of all options missing a default value.
- *
- * @return string[] The names of the missing options
- *
- * @see isMissing()
- */
- public function getMissingOptions()
- {
- return array_keys(array_diff_key($this->required, $this->defaults));
- }
- /**
- * Defines a valid option name.
- *
- * Defines an option name without setting a default value. The option will
- * be accepted when passed to {@link resolve()}. When not passed, the
- * option will not be included in the resolved options.
- *
- * @param string|string[] $optionNames One or more option names
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- 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;
- }
- /**
- * Returns whether an option is defined.
- *
- * Returns true for any option passed to {@link setDefault()},
- * {@link setRequired()} or {@link setDefined()}.
- *
- * @param string $option The option name
- *
- * @return bool Whether the option is defined
- */
- public function isDefined(string $option)
- {
- return isset($this->defined[$option]);
- }
- /**
- * Returns the names of all defined options.
- *
- * @return string[] The names of the defined options
- *
- * @see isDefined()
- */
- public function getDefinedOptions()
- {
- 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 $package The name of the composer package that is triggering the deprecation
- * @param string $version The version of the package that introduced the deprecation
- * @param string|\Closure $message The deprecation message to use
- */
- public function setDeprecated(string $option/*, string $package, string $version, $message = '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))));
- }
- $args = \func_get_args();
- if (\func_num_args() < 3) {
- trigger_deprecation('symfony/options-resolver', '5.1', 'The signature of method "%s()" requires 2 new arguments: "string $package, string $version", not defining them is deprecated.', __METHOD__);
- $message = $args[1] ?? 'The option "%name%" is deprecated.';
- $package = $version = '';
- } else {
- $package = $args[1];
- $version = $args[2];
- $message = $args[3] ?? 'The option "%name%" is deprecated.';
- }
- if (!\is_string($message) && !$message instanceof \Closure) {
- throw new InvalidArgumentException(sprintf('Invalid type for deprecation message argument, expected string or \Closure, but got "%s".', get_debug_type($message)));
- }
- // ignore if empty string
- if ('' === $message) {
- return $this;
- }
- $this->deprecated[$option] = [
- 'package' => $package,
- 'version' => $version,
- 'message' => $message,
- ];
- // 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.
- *
- * The normalizer should be a closure with the following signature:
- *
- * function (Options $options, $value) {
- * // ...
- * }
- *
- * 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.
- *
- * @param string $option The option name
- * @param \Closure $normalizer The normalizer
- *
- * @return $this
- *
- * @throws UndefinedOptionsException If the option is undefined
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function setNormalizer(string $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".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
- }
- $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.
- *
- * @param string $option The option name
- * @param \Closure $normalizer The normalizer
- * @param bool $forcePrepend If set to true, prepend instead of appending
- *
- * @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) {
- array_unshift($this->normalizers[$option], $normalizer);
- } else {
- $this->normalizers[$option][] = $normalizer;
- }
- // Make sure the option is processed
- unset($this->resolved[$option]);
- return $this;
- }
- /**
- * Sets allowed values for an option.
- *
- * Instead of passing values, you may also pass a closures with the
- * following signature:
- *
- * function ($value) {
- * // return true or false
- * }
- *
- * The closure receives the value as argument and should return true to
- * accept the value and false to reject the value.
- *
- * @param string $option The option name
- * @param mixed $allowedValues One or more acceptable values/closures
- *
- * @return $this
- *
- * @throws UndefinedOptionsException If the option is undefined
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function setAllowedValues(string $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".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
- }
- $this->allowedValues[$option] = \is_array($allowedValues) ? $allowedValues : [$allowedValues];
- // Make sure the option is processed
- unset($this->resolved[$option]);
- return $this;
- }
- /**
- * Adds allowed values for an option.
- *
- * The values are merged with the allowed values defined previously.
- *
- * Instead of passing values, you may also pass a closures with the
- * following signature:
- *
- * function ($value) {
- * // return true or false
- * }
- *
- * The closure receives the value as argument and should return true to
- * accept the value and false to reject the value.
- *
- * @param string $option The option name
- * @param mixed $allowedValues One or more acceptable values/closures
- *
- * @return $this
- *
- * @throws UndefinedOptionsException If the option is undefined
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function addAllowedValues(string $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".', $this->formatOptions([$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);
- }
- // Make sure the option is processed
- unset($this->resolved[$option]);
- return $this;
- }
- /**
- * Sets allowed types for an option.
- *
- * Any type for which a corresponding is_<type>() function exists is
- * acceptable. Additionally, fully-qualified class or interface names may
- * be passed.
- *
- * @param string $option The option name
- * @param string|string[] $allowedTypes One or more accepted types
- *
- * @return $this
- *
- * @throws UndefinedOptionsException If the option is undefined
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function setAllowedTypes(string $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".', $this->formatOptions([$option]), implode('", "', array_keys($this->defined))));
- }
- $this->allowedTypes[$option] = (array) $allowedTypes;
- // Make sure the option is processed
- unset($this->resolved[$option]);
- return $this;
- }
- /**
- * Adds allowed types for an option.
- *
- * The types are merged with the allowed types defined previously.
- *
- * Any type for which a corresponding is_<type>() function exists is
- * acceptable. Additionally, fully-qualified class or interface names may
- * be passed.
- *
- * @param string $option The option name
- * @param string|string[] $allowedTypes One or more accepted types
- *
- * @return $this
- *
- * @throws UndefinedOptionsException If the option is undefined
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function addAllowedTypes(string $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".', $this->formatOptions([$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);
- }
- // Make sure the option is processed
- unset($this->resolved[$option]);
- return $this;
- }
- /**
- * Defines an option configurator with the given name.
- */
- public function define(string $option): OptionConfigurator
- {
- if (isset($this->defined[$option])) {
- throw new OptionDefinitionException(sprintf('The option "%s" is already defined.', $option));
- }
- return new OptionConfigurator($option, $this);
- }
- /**
- * Sets an info message for an option.
- *
- * @return $this
- *
- * @throws UndefinedOptionsException If the option is undefined
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function setInfo(string $option, string $info): self
- {
- if ($this->locked) {
- throw new AccessException('The Info message 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))));
- }
- $this->info[$option] = $info;
- return $this;
- }
- /**
- * Gets the info message for an option.
- */
- public function getInfo(string $option): ?string
- {
- 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))));
- }
- return $this->info[$option] ?? null;
- }
- /**
- * Removes the option with the given name.
- *
- * Undefined options are ignored.
- *
- * @param string|string[] $optionNames One or more option names
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- 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], $this->info[$option]);
- }
- return $this;
- }
- /**
- * Removes all options.
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- 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 = [];
- $this->info = [];
- return $this;
- }
- /**
- * Merges options with the default values stored in the container and
- * validates them.
- *
- * Exceptions are thrown if:
- *
- * - Undefined options are passed;
- * - Required options are missing;
- * - 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
- * @throws InvalidOptionsException If an option doesn't fulfill the
- * specified validation rules
- * @throws MissingOptionsException If a required option is missing
- * @throws OptionDefinitionException If there is a cyclic dependency between
- * lazy options and/or normalizers
- * @throws NoSuchOptionException If a lazy option reads an unavailable option
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function resolve(array $options = [])
- {
- if ($this->locked) {
- throw new AccessException('Options cannot be resolved from a lazy option or normalizer.');
- }
- // Allow this method to be called multiple times
- $clone = clone $this;
- // Make sure that no unknown options are passed
- $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".', $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]);
- }
- // Check whether any required option is missing
- $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.', $this->formatOptions(array_keys($diff))));
- }
- // Lock the container
- $clone->locked = true;
- // Now process the individual options. Use offsetGet(), which resolves
- // the option itself and any options that the option depends on
- foreach ($clone->defaults as $option => $_) {
- $clone->offsetGet($option);
- }
- return $clone->resolved;
- }
- /**
- * Returns the resolved value of an option.
- *
- * @param string $option The option name
- * @param bool $triggerDeprecation Whether to trigger the deprecation or not (true by default)
- *
- * @return mixed The option value
- *
- * @throws AccessException If accessing this method outside of
- * {@link resolve()}
- * @throws NoSuchOptionException If the option is not set
- * @throws InvalidOptionsException If the option doesn't fulfill the
- * specified validation rules
- * @throws OptionDefinitionException If there is a cyclic dependency between
- * lazy options and/or normalizers
- */
- 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.');
- }
- // Shortcut for resolved options
- 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]['message'])) {
- trigger_deprecation($this->deprecated[$option]['package'], $this->deprecated[$option]['version'], strtr($this->deprecated[$option]['message'], ['%name%' => $option]));
- }
- return $this->resolved[$option];
- }
- // Check whether the option is set at all
- 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".', $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.', $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), get_debug_type($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.', $this->formatOptions(array_keys($this->calling))));
- }
- // 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 {
- foreach ($this->lazy[$option] as $closure) {
- $value = $closure($this, $value);
- }
- } finally {
- unset($this->calling[$option]);
- }
- // END
- }
- // Validate the type of the resolved option
- if (isset($this->allowedTypes[$option])) {
- $valid = true;
- $invalidTypes = [];
- foreach ($this->allowedTypes[$option] as $type) {
- $type = self::$typeAliases[$type] ?? $type;
- if ($valid = $this->verifyTypes($type, $value, $invalidTypes)) {
- break;
- }
- }
- if (!$valid) {
- $fmtActualValue = $this->formatValue($value);
- $fmtAllowedTypes = implode('" or "', $this->allowedTypes[$option]);
- $fmtProvidedTypes = implode('|', array_keys($invalidTypes));
- $allowedContainsArrayType = \count(array_filter($this->allowedTypes[$option], static function ($item) {
- return '[]' === substr(self::$typeAliases[$item] ?? $item, -2);
- })) > 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".', $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".', $this->formatOptions([$option]), $fmtActualValue, $fmtAllowedTypes, $fmtProvidedTypes));
- }
- }
- // Validate the value of the resolved option
- if (isset($this->allowedValues[$option])) {
- $success = false;
- $printableAllowedValues = [];
- foreach ($this->allowedValues[$option] as $allowedValue) {
- if ($allowedValue instanceof \Closure) {
- if ($allowedValue($value)) {
- $success = true;
- break;
- }
- // Don't include closures in the exception message
- 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)
- );
- }
- if (isset($this->info[$option])) {
- $message .= sprintf(' Info: %s.', $this->info[$option]);
- }
- throw new InvalidOptionsException($message);
- }
- }
- // 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])))) {
- $deprecation = $this->deprecated[$option];
- $message = $this->deprecated[$option]['message'];
- if ($message 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($message = $message($this, $value))) {
- throw new InvalidOptionsException(sprintf('Invalid type for deprecation message, expected string but got "%s", return an empty string to ignore.', get_debug_type($message)));
- }
- } finally {
- unset($this->calling[$option]);
- }
- }
- if ('' !== $message) {
- trigger_deprecation($deprecation['package'], $deprecation['version'], strtr($message, ['%name%' => $option]));
- }
- }
- // 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.', $this->formatOptions(array_keys($this->calling))));
- }
- // 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 {
- foreach ($this->normalizers[$option] as $normalizer) {
- $value = $normalizer($this, $value);
- }
- } finally {
- unset($this->calling[$option]);
- }
- // END
- }
- // Mark as resolved
- $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);
- $valid = true;
- foreach ($value as $val) {
- if (!$this->verifyTypes($type, $val, $invalidTypes, $level + 1)) {
- $valid = false;
- }
- }
- return $valid;
- }
- if (('null' === $type && null === $value) || (\function_exists($func = 'is_'.$type) && $func($value)) || $value instanceof $type) {
- return true;
- }
- if (!$invalidTypes || $level > 0) {
- $invalidTypes[get_debug_type($value)] = true;
- }
- return false;
- }
- /**
- * Returns whether a resolved option with the given name exists.
- *
- * @param string $option The option name
- *
- * @return bool Whether the option is set
- *
- * @throws AccessException If accessing this method outside of {@link resolve()}
- *
- * @see \ArrayAccess::offsetExists()
- */
- 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);
- }
- /**
- * Not supported.
- *
- * @throws AccessException
- */
- public function offsetSet($option, $value)
- {
- throw new AccessException('Setting options via array access is not supported. Use setDefault() instead.');
- }
- /**
- * Not supported.
- *
- * @throws AccessException
- */
- public function offsetUnset($option)
- {
- throw new AccessException('Removing options via array access is not supported. Use remove() instead.');
- }
- /**
- * Returns the number of set options.
- *
- * This may be only a subset of the defined options.
- *
- * @return int Number of options
- *
- * @throws AccessException If accessing this method outside of {@link resolve()}
- *
- * @see \Countable::count()
- */
- public function count()
- {
- if (!$this->locked) {
- throw new AccessException('Counting is only supported within closures of lazy options and normalizers.');
- }
- return \count($this->defaults);
- }
- /**
- * Returns a string representation of the value.
- *
- * This method returns the equivalent PHP tokens for most scalar types
- * (i.e. "false" for false, "1" for 1 etc.). Strings are always wrapped
- * in double quotes (").
- *
- * @param mixed $value The value to format as string
- */
- 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;
- }
- /**
- * Returns a string representation of a list of values.
- *
- * Each of the values is converted to a string using
- * {@link formatValue()}. The values are then concatenated with commas.
- *
- * @see formatValue()
- */
- private function formatValues(array $values): string
- {
- foreach ($values as $key => $value) {
- $values[$key] = $this->formatValue($value);
- }
- return implode(', ', $values);
- }
- private function formatOptions(array $options): string
- {
- if ($this->parentsOptions) {
- $prefix = array_shift($this->parentsOptions);
- if ($this->parentsOptions) {
- $prefix .= sprintf('[%s]', implode('][', $this->parentsOptions));
- }
- $options = array_map(static function (string $option) use ($prefix): string {
- return sprintf('%s[%s]', $prefix, $option);
- }, $options);
- }
- return implode('", "', $options);
- }
- private function getParameterClassName(\ReflectionParameter $parameter): ?string
- {
- if (!($type = $parameter->getType()) || $type->isBuiltin()) {
- return null;
- }
- return $type->getName();
- }
- }
|