phpDocumentor

UsesDescriptor extends TagDescriptor
in package
implements Stringable

FinalYes

Descriptor representing the uses tag on any element.

Table of Contents

Interfaces

Stringable

Properties

$description  : DescriptionDescriptor|null
$errors  : Collection<string|int, Error>
$name  : string
$reference  : Fqsen|Descriptor|null

Methods

__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getName()  : string
Returns the name for this element.
getReference()  : Fqsen|Descriptor|null
Returns the FQSEN, or Descriptor after linking, to which this tag points.
setDescription()  : void
Sets a description or none to inherit from a parent.
setReference()  : void
Sets the FQSEN or Descriptor to which this tag points.

Properties

Methods

getName()

Returns the name for this element.

public getName() : string
Return values
string

getReference()

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

public getReference() : Fqsen|Descriptor|null
Return values
Fqsen|Descriptor|null

setReference()

Sets the FQSEN or Descriptor to which this tag points.

public setReference(Fqsen|Descriptor|null $reference) : void
Parameters
$reference : Fqsen|Descriptor|null

        
On this page

Search results