PHPFUI/InstaDoc

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(?string $variableName, ?phpDocumentor\Reflection\Type $type = NULL, bool $isVariadic = false, ?phpDocumentor\Reflection\DocBlock\Description $description = NULL)
public __toString() : string
 

Returns a string representation for this tag.

public static create(string $body, ?phpDocumentor\Reflection\TypeResolver $typeResolver = NULL, ?phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory = NULL, ?phpDocumentor\Reflection\Types\Context $context = NULL) : self
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription() : phpDocumentor\Reflection\DocBlock\Description
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName() : string
 

Gets the name of this tag.

  • return string The name of this tag.
public phpDocumentor\Reflection\DocBlock\Tags\TagWithType::getType() : phpDocumentor\Reflection\Type
 

Returns the type section of the variable.

public getVariableName() : string
 

Returns the variable's name.

public isVariadic() : bool
 

Returns whether this tag is variadic.

public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render(?phpDocumentor\Reflection\DocBlock\Tags\Formatter $formatter = NULL) : string
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
 
  • return string[]
Properties
private $isVariadic
 
  • var bool determines whether this is a variadic argument
private $variableName
 
  • var string|null
Methods
public static create(string $body, ?phpDocumentor\Reflection\TypeResolver $typeResolver = NULL, ?phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory = NULL, ?phpDocumentor\Reflection\Types\Context $context = NULL) : self
protected static phpDocumentor\Reflection\DocBlock\Tags\TagWithType::extractTypeFromBody(string $body) : array
 
  • return string[]
© 2020 Bruce Wells
Search Namespaces \ Classes
ConfigurationNumbers (0-9.) only