class FilterBase
Same name in other branches
- 9 core/modules/filter/src/Plugin/FilterBase.php \Drupal\filter\Plugin\FilterBase
- 8.9.x core/modules/filter/src/Plugin/FilterBase.php \Drupal\filter\Plugin\FilterBase
- 11.x core/modules/filter/src/Plugin/FilterBase.php \Drupal\filter\Plugin\FilterBase
Provides a base class for Filter plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\filter\Plugin\FilterBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\filter\Plugin\FilterInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of FilterBase
See also
\Drupal\filter\Annotation\Filter
\Drupal\filter\FilterPluginManager
\Drupal\filter\Plugin\FilterInterface
23 files declare their use of FilterBase
- EditorFileReference.php in core/
modules/ editor/ src/ Plugin/ Filter/ EditorFileReference.php - FilterAlign.php in core/
modules/ filter/ src/ Plugin/ Filter/ FilterAlign.php - FilterAutoP.php in core/
modules/ filter/ src/ Plugin/ Filter/ FilterAutoP.php - FilterCaption.php in core/
modules/ filter/ src/ Plugin/ Filter/ FilterCaption.php - FilterHtml.php in core/
modules/ filter/ src/ Plugin/ Filter/ FilterHtml.php
File
-
core/
modules/ filter/ src/ Plugin/ FilterBase.php, line 16
Namespace
Drupal\filter\PluginView source
abstract class FilterBase extends PluginBase implements FilterInterface {
/**
* The name of the provider that owns this filter.
*
* @var string
*/
public $provider;
/**
* A Boolean indicating whether this filter is enabled.
*
* @var bool
*/
public $status = FALSE;
/**
* The weight of this filter compared to others in a filter collection.
*
* @var int
*/
public $weight = 0;
/**
* An associative array containing the configured settings of this filter.
*
* @var array
*/
public $settings = [];
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->provider = $this->pluginDefinition['provider'];
$this->setConfiguration($configuration);
}
/**
* {@inheritdoc}
*/
public function setConfiguration(array $configuration) {
if (isset($configuration['status'])) {
$this->status = (bool) $configuration['status'];
}
if (isset($configuration['weight'])) {
$this->weight = (int) $configuration['weight'];
}
if (isset($configuration['settings'])) {
$this->settings = (array) $configuration['settings'];
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getConfiguration() {
return [
'id' => $this->getPluginId(),
'provider' => $this->pluginDefinition['provider'],
'status' => $this->status,
'weight' => $this->weight,
'settings' => $this->settings,
];
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'provider' => $this->pluginDefinition['provider'],
'status' => FALSE,
'weight' => $this->pluginDefinition['weight'] ?: 0,
'settings' => $this->pluginDefinition['settings'],
];
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
return [];
}
/**
* {@inheritdoc}
*/
public function getType() {
return $this->pluginDefinition['type'];
}
/**
* {@inheritdoc}
*/
public function getLabel() {
return $this->pluginDefinition['title'];
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this->pluginDefinition['description'];
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
// Implementations should work with and return $form. Returning an empty
// array here allows the text format administration form to identify whether
// the filter plugin has any settings form elements.
return [];
}
/**
* {@inheritdoc}
*/
public function prepare($text, $langcode) {
return $text;
}
/**
* {@inheritdoc}
*/
public function getHTMLRestrictions() {
return FALSE;
}
/**
* {@inheritdoc}
*/
public function tips($long = FALSE) {
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FilterBase::$provider | public | property | The name of the provider that owns this filter. | ||
FilterBase::$settings | public | property | An associative array containing the configured settings of this filter. | ||
FilterBase::$status | public | property | A Boolean indicating whether this filter is enabled. | ||
FilterBase::$weight | public | property | The weight of this filter compared to others in a filter collection. | ||
FilterBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 1 |
FilterBase::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ConfigurableInterface::defaultConfiguration | |
FilterBase::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableInterface::getConfiguration | |
FilterBase::getDescription | public | function | Returns the administrative description for this filter plugin. | Overrides FilterInterface::getDescription | |
FilterBase::getHTMLRestrictions | public | function | Returns HTML allowed by this filter's configuration. | Overrides FilterInterface::getHTMLRestrictions | 4 |
FilterBase::getLabel | public | function | Returns the administrative label for this filter plugin. | Overrides FilterInterface::getLabel | |
FilterBase::getType | public | function | Returns the processing type of this filter plugin. | Overrides FilterInterface::getType | |
FilterBase::prepare | public | function | Prepares the text for processing. | Overrides FilterInterface::prepare | |
FilterBase::setConfiguration | public | function | Sets the configuration for this plugin instance. | Overrides ConfigurableInterface::setConfiguration | 1 |
FilterBase::settingsForm | public | function | Generates a filter's settings form. | Overrides FilterInterface::settingsForm | 3 |
FilterBase::tips | public | function | Generates a filter's tip. | Overrides FilterInterface::tips | 9 |
FilterBase::__construct | public | function | 4 | ||
FilterInterface::process | public | function | Performs the filter processing. | 23 | |
FilterInterface::TYPE_HTML_RESTRICTOR | constant | HTML tag and attribute restricting filters to prevent XSS attacks. | |||
FilterInterface::TYPE_MARKUP_LANGUAGE | constant | Non-HTML markup language filters that generate HTML. | |||
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE | constant | Irreversible transformation filters. | |||
FilterInterface::TYPE_TRANSFORM_REVERSIBLE | constant | Reversible transformation filters. | |||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.