phpDocumentor

Filterable extends Descriptor

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

Tags

Table of Contents

getDescription()  : DescriptionDescriptor|null
Returns the description for this element.
getName()  : string
Returns the local name for this element.
setErrors()  : void
Sets a list of errors on the associated element.

Methods

getDescription()

Returns the description for this element.

public getDescription() : DescriptionDescriptor|null

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

Tags
Return values
DescriptionDescriptor|null

getName()

Returns the local name for this element.

public getName() : string
Tags
Return values
string

setErrors()

Sets a list of errors on the associated element.

public setErrors(Collection<string|int, Error$errors) : void
Parameters
$errors : Collection<string|int, Error>
Tags
Return values
void

        

Search results