\phpDocumentor\Descriptor\TagUsedByDescriptor

Descriptor representing the uses tag on any element.

Summary

Methods

Properties

Constants

__construct()
__toString()
getName()
setDescription()
getDescription()
getErrors()
getReference()
setReference()

No public properties found

No constants found

No protected methods found

$name
$description
$errors

N/A

No private methods found

$reference

N/A

final

File: src/phpDocumentor/Descriptor/Tag/UsedByDescriptor.php
Package: AST\Tags
Class hierarchy: TagDescriptor

\phpDocumentor\Descriptor\Tag\UsedByDescriptor
Uses

Properties

$name

$name : string

Type

string

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$errors

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

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> — A collection of errors found during filtering.

$reference

$reference : \phpDocumentor\Reflection\Fqsen|\phpDocumentor\Descriptor\Interfaces\ElementInterface|null

Type

\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Descriptor\Interfaces\ElementInterface|null — the FQSEN where the uses tag refers to

Methods

__construct()

__construct(string  $name, ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description = null) : mixed

Initializes the tag by setting the name and errors,

Parameters

string	$name
?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor	$description

Returns

mixed —

__toString()

__toString() : string

Returns

string —

getName()

getName() : string

Returns the name for this element.

Returns

string —

setDescription()

setDescription(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$description

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getErrors()

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

Returns all errors associated with this tag.

Returns

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

getReference()

getReference() : \phpDocumentor\Reflection\Fqsen|\phpDocumentor\Descriptor\Interfaces\ElementInterface|null

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

Returns

\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Descriptor\Interfaces\ElementInterface|null —

setReference()

setReference(\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Descriptor\Interfaces\ElementInterface|null  $reference) : void

Sets the FQSEN or Descriptor to which this tag points.

Parameters

\phpDocumentor\Reflection\Fqsen|\phpDocumentor\Descriptor\Interfaces\ElementInterface|null

$reference