\phpDocumentor\Descriptor\FilterFilterable

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

Summary

Methods
Constants
getName()
setName()
getDescription()
setDescription()
setErrors()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getName()

getName() : string

Returns the local name for this element.

Returns

string —

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

string $name

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 —

setDescription()

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

Sets a longer description for this element.

Parameters

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

setErrors()

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

Sets a list of errors on the associated element.

Parameters

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