\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

getName() : string

Returns the local name for this element.

string —

setName(string  $name) : void

Sets the local name for this element.

string

$name

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.

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

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

Sets a longer description for this element.

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$description

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

Sets a list of errors on the associated element.

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

$errors