Defines an filter annotation object.
Expanded class hierarchy of Filter
class Filter extends Plugin {
/**
* The plugin ID.
*
* @var string
*/
public $id;
/**
* The name of the module providing the type.
*
* @var string
*/
public $module;
/**
* The human-readable name of the filter.
*
* This is used as an administrative summary of what the filter does.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $title;
/**
* Additional administrative information about the filter's behavior.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation (optional)
*/
public $description = '';
/**
* A default weight for the filter in new text formats.
*
* @var int (optional)
*/
public $weight = 0;
/**
* Whether this filter is enabled or disabled by default.
*
* @var bool (optional)
*/
public $status = FALSE;
/**
* Specifies whether the filtered text can be cached.
*
* Note that setting this to FALSE makes the entire text format not cacheable,
* which may have an impact on the site's overall performance.
*
* @var bool (optional)
*/
public $cache = TRUE;
/**
* The default settings for the filter.
*
* @var array (optional)
*/
public $settings = array();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Filter:: |
public | property | Specifies whether the filtered text can be cached. | |
Filter:: |
public | property | Additional administrative information about the filter's behavior. | |
Filter:: |
public | property | The plugin ID. | |
Filter:: |
public | property | The name of the module providing the type. | |
Filter:: |
public | property | The default settings for the filter. | |
Filter:: |
public | property | Whether this filter is enabled or disabled by default. | |
Filter:: |
public | property | The human-readable name of the filter. | |
Filter:: |
public | property | A default weight for the filter in new text formats. | |
Plugin:: |
protected | property | The plugin definiton read from the class annotation. | |
Plugin:: |
public | function |
Implements Drupal\Core\Annotation\AnnotationInterface::get(). Overrides AnnotationInterface:: |
|
Plugin:: |
protected | function | Parses an annotation into its definition. | |
Plugin:: |
public | function | Constructs a Plugin object. |