PropertyDescriptor
in package
extends TypedVariableAbstract
Descriptor representing the property tag on a class or trait.
Properties
$variableName inherited
protected$variableName : string
$types inherited
protected$types : \phpDocumentor\Reflection\Type
- Inherited from
- \phpDocumentor\Descriptor\Tag\BaseTypes\TypedAbstract
$name inherited
protected$name : string
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
$description inherited
protected$description : string
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
$errors inherited
protected$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
Methods
getVariableName() inherited
Retrieves the variable name stored on this descriptor.
publicgetVariableName() : string
setVariableName() inherited
Sets the variable name on this descriptor.
publicsetVariableName(string $variableName) : void
Parameters
setTypes() inherited
Sets a list of types associated with this tag.
publicsetTypes([Type|null $types = null ]) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\Tag\BaseTypes\TypedAbstract
setType() inherited
Sets a list of types associated with this tag.
publicsetType([Type|null $types = null ]) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\Tag\BaseTypes\TypedAbstract
getTypes() inherited
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> —- Inherited from
- \phpDocumentor\Descriptor\Tag\BaseTypes\TypedAbstract
getType() inherited
publicgetType() : Type|null
__construct() inherited
Initializes the tag by setting the name and errors,
public__construct(string $name) : mixed
setDescription() inherited
Sets a description for this tab instance.
publicsetDescription(string $description) : void
setErrors() inherited
Sets a list of errors found on the usage of this tag.
publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor
getErrors() inherited
Returns all errors associated with this tag.
publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —- Inherited from
- \phpDocumentor\Descriptor\TagDescriptor