Reflection class for the {@}param tag in a Docblock.

CloneableFinalInstantiable
ExtendsphpDocumentor\Reflection\DocBlock\Tags\TagWithType
phpDocumentor\Reflection\DocBlock\Tags\BaseTag
ImplementsphpDocumentor\Reflection\DocBlock\Tag
phpDocumentor\Reflection\DocBlock\Tags\Factory\StaticMethod
Methods
public __construct( $variableName, ?phpDocumentor\Reflection\Type $type = NULL, $isVariadic = false, ?phpDocumentor\Reflection\DocBlock\Description $description = NULL)
 


    public __toString()
     
    Returns a string representation for this tag.

    • return string
    public static create( $body, ?phpDocumentor\Reflection\TypeResolver $typeResolver = NULL, ?phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory = NULL, ?phpDocumentor\Reflection\Types\Context $context = NULL)
     
    {@inheritdoc}

    public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription()
    public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName()
     
    Gets the name of this tag.

    • return string The name of this tag.
    public phpDocumentor\Reflection\DocBlock\Tags\TagWithType::getType()
     
    Returns the type section of the variable.

    • return Type
    public getVariableName()
     
    Returns the variable's name.

    • return string
    public isVariadic()
     
    Returns whether this tag is variadic.

    • return bool
    public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render(?phpDocumentor\Reflection\DocBlock\Tags\Formatter $formatter = NULL)
    Properties
    protected phpDocumentor\Reflection\DocBlock\Tags\BaseTag::$description
     


    • var Description|null Description of the tag.
    protected phpDocumentor\Reflection\DocBlock\Tags\BaseTag::$name
     


    • var string Name of the tag
    protected phpDocumentor\Reflection\DocBlock\Tags\TagWithType::$type
     


    • var Type
    Methods
    protected static phpDocumentor\Reflection\DocBlock\Tags\TagWithType::extractTypeFromBody(string $body) : array
    Properties
    private $isVariadic
     


    • var bool determines whether this is a variadic argument
    private $variableName
     


    • var string
    Methods
    public static create( $body, ?phpDocumentor\Reflection\TypeResolver $typeResolver = NULL, ?phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory = NULL, ?phpDocumentor\Reflection\Types\Context $context = NULL)
     
    {@inheritdoc}

    protected static phpDocumentor\Reflection\DocBlock\Tags\TagWithType::extractTypeFromBody(string $body) : array
    © 2020 Bruce Wells
    Search Namespaces \ Classes
    ConfigurationNumbers (0-9.) only