class FilterTestPlaceholders

Same name and namespace in other branches
  1. 8.9.x core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php \Drupal\filter_test\Plugin\Filter\FilterTestPlaceholders
  2. 10 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php \Drupal\filter_test\Plugin\Filter\FilterTestPlaceholders
  3. 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\filter_test\Plugin\Filter\FilterTestPlaceholders extends \Drupal\Core\Security\TrustedCallbackInterface implements \Drupal\filter\Plugin\FilterBase

Expanded class hierarchy of FilterTestPlaceholders

File

core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestPlaceholders.php, line 20

Namespace

Drupal\filter_test\Plugin\Filter
View on git.drupalcode.org
View 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 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 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 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 Overrides FilterInterface::process
FilterTestPlaceholders::renderDynamicThing public static function #lazy_builder callback; builds a render array containing the dynamic thing.
FilterTestPlaceholders::trustedCallbacks public static function 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.