class FilterTestPlaceholders
Same name and namespace in other branches
- 11.x 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
- 9 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php \Drupal\filter_test\Plugin\Filter\FilterTestPlaceholders
- 8.9.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.
Attributes
#[Filter(id: "filter_test_placeholders", title: new TranslatableMarkup("Testing filter"), description: new TranslatableMarkup("Appends placeholders to the content; associates #lazy_builder callbacks."), type: FilterInterface::TYPE_TRANSFORM_REVERSIBLE)]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\filter\Plugin\FilterBase implements \Drupal\filter\Plugin\FilterInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\filter_test\Plugin\Filter\FilterTestPlaceholders implements \Drupal\Core\Security\TrustedCallbackInterface extends \Drupal\filter\Plugin\FilterBase
- class \Drupal\filter\Plugin\FilterBase implements \Drupal\filter\Plugin\FilterInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of FilterTestPlaceholders
File
-
core/
modules/ filter/ tests/ filter_test/ src/ Plugin/ Filter/ FilterTestPlaceholders.php, line 18
Namespace
Drupal\filter_test\Plugin\FilterView source
class FilterTestPlaceholders extends FilterBase implements TrustedCallbackInterface {
/**
* {@inheritdoc}
*/
public function process($text, $langcode) {
$result = new FilterProcessResult($text);
$placeholder_with_argument = $result->createPlaceholder('\\Drupal\\filter_test\\Plugin\\Filter\\FilterTestPlaceholders::renderDynamicThing', [
'llama',
]);
$placeholder_without_arguments = $result->createPlaceholder('\\Drupal\\filter_test\\Plugin\\Filter\\FilterTestPlaceholders::renderStaticThing', []);
$result->setProcessedText($text . '<p>' . $placeholder_with_argument . '</p><p>' . $placeholder_without_arguments . '</p>');
return $result;
}
/**
* Render API callback: Builds a render array containing the dynamic thing.
*
* This function is assigned as a #lazy_builder callback.
*
* @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,
]),
];
}
/**
* Render API callback: Builds a render array.
*
* This function is assigned as a #lazy_builder callback.
*
* @return array
* A renderable array.
*/
public static function renderStaticThing() : array {
return [
'#markup' => 'This is a static llama.',
];
}
/**
* {@inheritdoc}
*/
public static function trustedCallbacks() {
return [
'renderDynamicThing',
'renderStaticThing',
];
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | ||
| AutowiredInstanceTrait::getAutowireArguments | private static | function | Resolves arguments for a method using autowiring. | ||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||
| 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 | Overrides DependentPluginInterface::calculateDependencies | 1 | |
| FilterBase::defaultConfiguration | public | function | Overrides ConfigurableInterface::defaultConfiguration | ||
| FilterBase::getConfiguration | public | function | Overrides ConfigurableInterface::getConfiguration | ||
| FilterBase::getDescription | public | function | Overrides FilterInterface::getDescription | ||
| FilterBase::getHTMLRestrictions | public | function | Overrides FilterInterface::getHTMLRestrictions | 4 | |
| FilterBase::getLabel | public | function | Overrides FilterInterface::getLabel | ||
| FilterBase::getType | public | function | Overrides FilterInterface::getType | ||
| FilterBase::prepare | public | function | Overrides FilterInterface::prepare | ||
| FilterBase::setConfiguration | public | function | Overrides ConfigurableInterface::setConfiguration | 1 | |
| FilterBase::settingsForm | public | function | Overrides FilterInterface::settingsForm | 3 | |
| FilterBase::tips | public | function | Overrides FilterInterface::tips | 9 | |
| FilterBase::__construct | public | function | Overrides PluginBase::__construct | 7 | |
| 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 | Overrides FilterInterface::process | ||
| FilterTestPlaceholders::renderDynamicThing | public static | function | Render API callback: Builds a render array containing the dynamic thing. | ||
| FilterTestPlaceholders::renderStaticThing | public static | function | Render API callback: Builds a render array. | ||
| FilterTestPlaceholders::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 26 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 26 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| PluginBase::$pluginId | protected | property | The plugin ID. | ||
| PluginBase::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 68 | |
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
| PluginBase::getBaseId | public | function | Overrides DerivativeInspectionInterface::getBaseId | ||
| PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | ||
| PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
| PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | |
| TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
| TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.