TagDescriptor

in package

Implements Filterable

Base class for any tag descriptor and used when a tag has no specific descriptor.

Interfaces, Classes & Used Traits

Filterable: Interface to determine which elements can be filtered and to provide a way to set errors on the descriptor.

protected$name  : string

protected$description  : string

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

Initializes the tag by setting the name and errors,

public__construct(string $name) : mixed

$name : string

mixed —

Returns the name for this tag.

publicgetName() : string

string —

Sets a description for this tab instance.

publicsetDescription(string $description) : void

$description : string

Returns the description for this tag,

publicgetDescription() : string

string —

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

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

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

Returns all errors associated with this tag.

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

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

Sets the name for this tag.

protectedsetName(string $name) : void

$name : string