VarDescriptor

in package
extends TypedVariableAbstract

Descriptor representing the var tag on a property.

Properties

protected$types  : \phpDocumentor\Reflection\Type                

protected$name  : string                

protected$description  : string                

protected$errors  : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>                

Methods

Retrieves the variable name stored on this descriptor.

publicgetVariableName() : string

Sets the variable name on this descriptor.

publicsetVariableName(string $variableName) : void

Parameters

$variableName : string

Sets a list of types associated with this tag.

publicsetTypes([Type|null $types = null ]) : void

Parameters

$types : Type|null = null

Sets a list of types associated with this tag.

publicsetType([Type|null $types = null ]) : void

Parameters

$types : Type|null = null

Returns the list of types associated with this tag.

publicgetTypes() : \phpDocumentor\Descriptor\Tag\BaseTypes\list<\phpDocumentor\Reflection\Type>

Returns

\phpDocumentor\Descriptor\Tag\BaseTypes\list<\phpDocumentor\Reflection\Type>

publicgetType() : Type|null

Returns

Type|null

Initializes the tag by setting the name and errors,

public__construct(string $name) : mixed

Parameters

$name : string

Returns

mixed

Returns the name for this tag.

publicgetName() : string

Returns

string

Sets a description for this tab instance.

publicsetDescription(string $description) : void

Parameters

$description : string

Returns the description for this tag,

publicgetDescription() : string

Returns

string

Sets a list of errors found on the usage of this tag.

publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void

Parameters

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors associated with this tag.

publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Sets the name for this tag.

protectedsetName(string $name) : void

Parameters

$name : string