Filter
class Filter extends Plugin (View source)
Defines a filter annotation object.
Plugin Namespace: Plugin\Filter
For a working example, see \Drupal\filter\Plugin\Filter\FilterHtml
Properties
| protected array | $definition | The plugin definition read from the class annotation. |
from Plugin |
| string | $id | The plugin ID. |
|
| string | $provider | The name of the provider that owns the filter. |
|
| Translation | $title | The human-readable name of the filter. |
|
| Translation | $description | Additional administrative information about the filter's behavior. |
|
| int | $weight | A default weight for the filter in new text formats. |
|
| bool | $status | Whether this filter is enabled or disabled by default. |
|
| array | $settings | The default settings for the filter. |
Methods
Details
in
Plugin at line 35
__construct($values)
Constructs a Plugin object.
Builds up the plugin definition and invokes the get() method for any classed annotations that were used.
in
Plugin at line 54
protected array
parse(array $values)
Parses an annotation into its definition.
in
Plugin at line 73
get()
Gets the value of an annotation.
in
Plugin at line 80
string
getProvider()
Gets the name of the provider of the annotated class.
in
Plugin at line 87
setProvider(string $provider)
Sets the name of the provider of the annotated class.
in
Plugin at line 94
string
getId()
Gets the unique ID for this annotated class.
string
getClass()
Gets the class of the annotated class.
setClass(string $class)
Sets the class of the annotated class.