UsesDescriptor

in package
extends TagDescriptor

Descriptor representing the uses tag on any element.

Properties

protected$name  : string                

protected$description  : string                

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

private$reference  : \phpDocumentor\Reflection\Fqsen|\phpDocumentor\Descriptor\Descriptor                

Methods

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>

Returns the FQSEN, or Descriptor after linking, to which this tag points.

publicgetReference() : Fqsen|Descriptor|null

Returns

Fqsen|Descriptor|null

Sets the FQSEN or Descriptor to which this tag points.

publicsetReference(Fqsen|Descriptor|null $reference) : void

Parameters

$reference : Fqsen|Descriptor|null

Sets the name for this tag.

protectedsetName(string $name) : void

Parameters

$name : string