123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143 |
- <?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;
- final class OptionConfigurator
- {
- private $name;
- private $resolver;
- public function __construct(string $name, OptionsResolver $resolver)
- {
- $this->name = $name;
- $this->resolver = $resolver;
- $this->resolver->setDefined($name);
- }
- /**
- * Adds allowed types for this option.
- *
- * @param string ...$types One or more accepted types
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function allowedTypes(string ...$types): self
- {
- $this->resolver->setAllowedTypes($this->name, $types);
- return $this;
- }
- /**
- * Sets allowed values for this option.
- *
- * @param mixed ...$values One or more acceptable values/closures
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function allowedValues(...$values): self
- {
- $this->resolver->setAllowedValues($this->name, $values);
- return $this;
- }
- /**
- * Sets the default value for this option.
- *
- * @param mixed $value The default value of the option
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function default($value): self
- {
- $this->resolver->setDefault($this->name, $value);
- return $this;
- }
- /**
- * Defines an option configurator with the given name.
- */
- public function define(string $option): self
- {
- return $this->resolver->define($option);
- }
- /**
- * Marks this option as deprecated.
- *
- * @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
- *
- * @return $this
- */
- public function deprecated(string $package, string $version, $message = 'The option "%name%" is deprecated.'): self
- {
- $this->resolver->setDeprecated($this->name, $package, $version, $message);
- return $this;
- }
- /**
- * Sets the normalizer for this option.
- *
- * @param \Closure $normalizer The normalizer
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function normalize(\Closure $normalizer): self
- {
- $this->resolver->setNormalizer($this->name, $normalizer);
- return $this;
- }
- /**
- * Marks this option as required.
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function required(): self
- {
- $this->resolver->setRequired($this->name);
- return $this;
- }
- /**
- * Sets an info message for an option.
- *
- * @return $this
- *
- * @throws AccessException If called from a lazy option or normalizer
- */
- public function info(string $info): self
- {
- $this->resolver->setInfo($this->name, $info);
- return $this;
- }
- }
|