123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108 |
- <?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\HttpKernel\ControllerMetadata;
- /**
- * Responsible for storing metadata of an argument.
- *
- * @author Iltar van der Berg <kjarli@gmail.com>
- */
- class ArgumentMetadata
- {
- private $name;
- private $type;
- private $isVariadic;
- private $hasDefaultValue;
- private $defaultValue;
- private $isNullable;
- public function __construct(string $name, ?string $type, bool $isVariadic, bool $hasDefaultValue, $defaultValue, bool $isNullable = false)
- {
- $this->name = $name;
- $this->type = $type;
- $this->isVariadic = $isVariadic;
- $this->hasDefaultValue = $hasDefaultValue;
- $this->defaultValue = $defaultValue;
- $this->isNullable = $isNullable || null === $type || ($hasDefaultValue && null === $defaultValue);
- }
- /**
- * Returns the name as given in PHP, $foo would yield "foo".
- *
- * @return string
- */
- public function getName()
- {
- return $this->name;
- }
- /**
- * Returns the type of the argument.
- *
- * The type is the PHP class in 5.5+ and additionally the basic type in PHP 7.0+.
- *
- * @return string|null
- */
- public function getType()
- {
- return $this->type;
- }
- /**
- * Returns whether the argument is defined as "...$variadic".
- *
- * @return bool
- */
- public function isVariadic()
- {
- return $this->isVariadic;
- }
- /**
- * Returns whether the argument has a default value.
- *
- * Implies whether an argument is optional.
- *
- * @return bool
- */
- public function hasDefaultValue()
- {
- return $this->hasDefaultValue;
- }
- /**
- * Returns whether the argument accepts null values.
- *
- * @return bool
- */
- public function isNullable()
- {
- return $this->isNullable;
- }
- /**
- * Returns the default value of the argument.
- *
- * @throws \LogicException if no default value is present; {@see self::hasDefaultValue()}
- *
- * @return mixed
- */
- public function getDefaultValue()
- {
- if (!$this->hasDefaultValue) {
- throw new \LogicException(sprintf('Argument $%s does not have a default value. Use "%s::hasDefaultValue()" to avoid this exception.', $this->name, __CLASS__));
- }
- return $this->defaultValue;
- }
- }
|