Filterable
extends
Descriptor
in
Interface to determine which elements can be filtered and to provide a way to set errors on the descriptor.
Table of Contents
Methods
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getName() : string
- Returns the local name for this element.
- setDescription() : void
- Sets a longer description for this element.
- setErrors() : void
- Sets a list of errors on the associated element.
- setName() : void
- Sets the local name for this element.
Methods
getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetName()
Returns the local name for this element.
public
getName() : string
Return values
stringsetDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
setErrors()
Sets a list of errors on the associated element.
public
setErrors(Collection<string|int, Error> $errors) : void
Parameters
- $errors : Collection<string|int, Error>
setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string