class FilterTestRestrictTagsAndAttributes in Zircon Profile 8.0
Same name and namespace in other branches
- 8 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestRestrictTagsAndAttributes.php \Drupal\filter_test\Plugin\Filter\FilterTestRestrictTagsAndAttributes
Provides a test filter to restrict HTML tags and attributes.
Plugin annotation
@Filter(
id = "filter_test_restrict_tags_and_attributes",
title = @Translation("Tag and attribute restricting filter"),
description = @Translation("Used for testing \Drupal\filter\Entity\FilterFormatInterface::getHtmlRestrictions()."),
type = Drupal\filter\Plugin\FilterInterface::TYPE_HTML_RESTRICTOR
)
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_test\Plugin\Filter\FilterTestRestrictTagsAndAttributes
- class \Drupal\filter\Plugin\FilterBase implements FilterInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of FilterTestRestrictTagsAndAttributes
File
- core/
modules/ filter/ tests/ filter_test/ src/ Plugin/ Filter/ FilterTestRestrictTagsAndAttributes.php, line 24 - Contains \Drupal\filter_test\Plugin\Filter\FilterTestRestrictTagsAndAttributes.
Namespace
Drupal\filter_test\Plugin\FilterView source
class FilterTestRestrictTagsAndAttributes extends FilterBase {
/**
* {@inheritdoc}
*/
public function process($text, $langcode) {
$allowed_tags = array_filter($this->settings['restrictions']['allowed'], function ($value) {
return is_array($value) || (bool) $value !== FALSE;
});
return new FilterProcessResult(Xss::filter($text, array_keys($allowed_tags)));
}
/**
* {@inheritdoc}
*/
public function getHTMLRestrictions() {
$restrictions = $this->settings['restrictions'];
// The configuration system stores FALSE as '0' and TRUE as '1'. Fix that.
if (isset($restrictions['allowed'])) {
foreach ($restrictions['allowed'] as $tag => $attrs_or_bool) {
if (!is_array($attrs_or_bool)) {
$restrictions['allowed'][$tag] = (bool) $attrs_or_bool;
}
else {
foreach ($attrs_or_bool as $attr => $attrvals_or_bool) {
if (!is_array($attrvals_or_bool)) {
$restrictions['allowed'][$tag][$attr] = (bool) $attrvals_or_bool;
}
else {
foreach ($attrvals_or_bool as $attrval => $bool) {
$restrictions['allowed'][$tag][$attr][$attrval] = (bool) $bool;
}
}
}
}
}
}
if (isset($restrictions['forbidden_tags'])) {
foreach ($restrictions['forbidden_tags'] as $tag => $bool) {
$restrictions['forbidden_tags'][$tag] = (bool) $bool;
}
}
return $restrictions;
}
}
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 |
FilterBase:: |
public | function |
Generates a filter's tip. Overrides FilterInterface:: |
8 |
FilterBase:: |
public | function |
Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
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. | ||
FilterTestRestrictTagsAndAttributes:: |
public | function |
Returns HTML allowed by this filter's configuration. Overrides FilterBase:: |
|
FilterTestRestrictTagsAndAttributes:: |
public | function |
Performs the filter processing. Overrides FilterInterface:: |
|
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. |