class StripTagsFilter in Typed Data API enhancements 8
A data filter call "strip_tags()".
Plugin annotation
@DataFilter(
id = "striptags",
label = @Translation("The striptags filter strips SGML/XML tags and replace adjacent whitespace by one space."),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\typed_data\DataFilterBase implements DataFilterInterface uses StringTranslationTrait, TypedDataTrait
- class \Drupal\typed_data\Plugin\TypedDataFilter\StripTagsFilter
- class \Drupal\typed_data\DataFilterBase implements DataFilterInterface uses StringTranslationTrait, TypedDataTrait
Expanded class hierarchy of StripTagsFilter
File
- src/
Plugin/ TypedDataFilter/ StripTagsFilter.php, line 19
Namespace
Drupal\typed_data\Plugin\TypedDataFilterView source
class StripTagsFilter extends DataFilterBase {
/**
* {@inheritdoc}
*/
public function filter(DataDefinitionInterface $definition, $value, array $arguments, BubbleableMetadata $bubbleable_metadata = NULL) {
return strip_tags($value);
}
/**
* {@inheritdoc}
*/
public function canFilter(DataDefinitionInterface $definition) {
return is_subclass_of($definition
->getClass(), StringInterface::class);
}
/**
* {@inheritdoc}
*/
public function filtersTo(DataDefinitionInterface $definition, array $arguments) {
return DataDefinition::create('string');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DataFilterBase:: |
protected | property | The filter id. | |
DataFilterBase:: |
protected | property |
The plugin definition. Overrides PluginBase:: |
|
DataFilterBase:: |
public | function |
Defines whether the filter is able to process NULL values. Overrides DataFilterInterface:: |
1 |
DataFilterBase:: |
public | function |
Gets the number of required arguments. Overrides DataFilterInterface:: |
2 |
DataFilterBase:: |
public | function |
Suggests some possible argument values based on user input. Overrides DataFilterInterface:: |
|
DataFilterBase:: |
public | function |
Validates the inputted arguments. Overrides DataFilterInterface:: |
3 |
DataFilterBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
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:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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. | |
StripTagsFilter:: |
public | function |
Determines whether data based upon the given definition can be filtered. Overrides DataFilterInterface:: |
|
StripTagsFilter:: |
public | function |
Filters the given data value. Overrides DataFilterInterface:: |
|
StripTagsFilter:: |
public | function |
Describes the data after applying the filter. Overrides DataFilterInterface:: |
|
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |