class FilterTestPlaceholders
Same name in other branches
- 9 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php \Drupal\filter_test\Plugin\Filter\FilterTestPlaceholders
- 10 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php \Drupal\filter_test\Plugin\Filter\FilterTestPlaceholders
- 11.x core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php \Drupal\filter_test\Plugin\Filter\FilterTestPlaceholders
Provides a test filter to use placeholders.
Plugin annotation
@Filter(
id = "filter_test_placeholders",
title = @Translation("Testing filter"),
description = @Translation("Appends a placeholder to the content; associates #lazy_builder callback."),
type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE
)
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\filter_test\Plugin\Filter\FilterTestPlaceholders extends \Drupal\filter\Plugin\FilterBase implements \Drupal\Core\Security\TrustedCallbackInterface
- 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 FilterTestPlaceholders
File
-
core/
modules/ filter/ tests/ filter_test/ src/ Plugin/ Filter/ FilterTestPlaceholders.php, line 20
Namespace
Drupal\filter_test\Plugin\FilterView source
class FilterTestPlaceholders extends FilterBase implements TrustedCallbackInterface {
/**
* {@inheritdoc}
*/
public function process($text, $langcode) {
$result = new FilterProcessResult($text);
$placeholder = $result->createPlaceholder('\\Drupal\\filter_test\\Plugin\\Filter\\FilterTestPlaceholders::renderDynamicThing', [
'llama',
]);
$result->setProcessedText($text . '<p>' . $placeholder . '</p>');
return $result;
}
/**
* #lazy_builder callback; builds a render array containing the dynamic thing.
*
* @param string $thing
* A "thing" string.
*
* @return array
* A renderable array.
*/
public static function renderDynamicThing($thing) {
return [
'#markup' => new FormattableMarkup('This is a dynamic @thing.', [
'@thing' => $thing,
]),
];
}
/**
* {@inheritdoc}
*/
public static function trustedCallbacks() {
return [
'renderDynamicThing',
];
}
}
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::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. | |||
FilterTestPlaceholders::process | public | function | Performs the filter processing. | Overrides FilterInterface::process | |
FilterTestPlaceholders::renderDynamicThing | public static | function | #lazy_builder callback; builds a render array containing the dynamic thing. | ||
FilterTestPlaceholders::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | |
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 | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | |||
TrustedCallbackInterface::TRIGGER_WARNING | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.