class FilterNull in Zircon Profile 8.0
Same name and namespace in other branches
- 8 core/modules/filter/src/Plugin/Filter/FilterNull.php \Drupal\filter\Plugin\Filter\FilterNull
Provides a fallback placeholder filter to use for missing filters.
The filter system uses this filter to replace missing filters (for example, if a filter module has been disabled) that are still part of defined text formats. It returns an empty string.
Plugin annotation
@Filter(
id = "filter_null",
title = @Translation("Provides a fallback for missing filters. Do not use."),
type = Drupal\filter\Plugin\FilterInterface::TYPE_HTML_RESTRICTOR,
weight = -10
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\filter\Plugin\FilterBase implements FilterInterface
- class \Drupal\filter\Plugin\Filter\FilterNull
- class \Drupal\filter\Plugin\FilterBase implements FilterInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of FilterNull
1 file declares its use of FilterNull
- FilterFormatFormBase.php in core/
modules/ filter/ src/ FilterFormatFormBase.php - Contains \Drupal\filter\FilterFormatFormBase.
File
- core/
modules/ filter/ src/ Plugin/ Filter/ FilterNull.php, line 27 - Contains \Drupal\filter\Plugin\Filter\FilterNull.
Namespace
Drupal\filter\Plugin\FilterView source
class FilterNull extends FilterBase {
/**
* Tracks if an alert about this filter has been logged.
*
* @var bool
*/
protected $logged = FALSE;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
// Once per filter, log that a filter plugin was missing.
if (!$this->logged) {
$this->logged = TRUE;
\Drupal::logger('filter')
->alert('Missing filter plugin: %filter.', array(
'%filter' => $plugin_id,
));
}
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
public function process($text, $langcode) {
return new FilterProcessResult('');
}
/**
* {@inheritdoc}
*/
public function getHTMLRestrictions() {
// Nothing is allowed.
return array(
'allowed' => array(),
);
}
/**
* {@inheritdoc}
*/
public function tips($long = FALSE) {
return $this
->t('Missing filter. All text is removed');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FilterBase:: |
protected | property | A collection of all filters this filter participates in. | |
FilterBase:: |
protected | property | The plugin ID of this filter. | |
FilterBase:: |
public | property | The name of the provider that owns this filter. | |
FilterBase:: |
public | property | An associative array containing the configured settings of this filter. | |
FilterBase:: |
public | property | A Boolean indicating whether this filter is enabled. | |
FilterBase:: |
public | property | The weight of this filter compared to others in a filter collection. | |
FilterBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
FilterBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurablePluginInterface:: |
|
FilterBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurablePluginInterface:: |
|
FilterBase:: |
public | function |
Returns the administrative description for this filter plugin. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Returns the administrative label for this filter plugin. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Returns the processing type of this filter plugin. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Prepares the text for processing. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface:: |
1 |
FilterBase:: |
public | function |
Generates a filter's settings form. Overrides FilterInterface:: |
2 |
FilterInterface:: |
constant | HTML tag and attribute restricting filters to prevent XSS attacks. | ||
FilterInterface:: |
constant | Non-HTML markup language filters that generate HTML. | ||
FilterInterface:: |
constant | Irreversible transformation filters. | ||
FilterInterface:: |
constant | Reversible transformation filters. | ||
FilterNull:: |
protected | property | Tracks if an alert about this filter has been logged. | |
FilterNull:: |
public | function |
Returns HTML allowed by this filter's configuration. Overrides FilterBase:: |
|
FilterNull:: |
public | function |
Performs the filter processing. Overrides FilterInterface:: |
|
FilterNull:: |
public | function |
Generates a filter's tip. Overrides FilterBase:: |
|
FilterNull:: |
public | function |
Constructs a Drupal\Component\Plugin\PluginBase object. Overrides FilterBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |