Classes List

Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
<?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;

    /** * @param string $name * @param string $type * @param bool $isVariadic * @param bool $hasDefaultValue * @param mixed $defaultValue * @param bool $isNullable */
    public function __construct($name$type$isVariadic$hasDefaultValue$defaultValue$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 */
    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;
    }
}