class FilterTestCacheMerge

Same name in other branches
  1. 9 core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheMerge.php \Drupal\filter_test\Plugin\Filter\FilterTestCacheMerge
  2. 8.9.x core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheMerge.php \Drupal\filter_test\Plugin\Filter\FilterTestCacheMerge
  3. 11.x core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheMerge.php \Drupal\filter_test\Plugin\Filter\FilterTestCacheMerge

Provides a test filter to merge with CacheableMetadata.

Hierarchy

Expanded class hierarchy of FilterTestCacheMerge

File

core/modules/filter/tests/filter_test/src/Plugin/Filter/FilterTestCacheMerge.php, line 15

Namespace

Drupal\filter_test\Plugin\Filter
View source
class FilterTestCacheMerge extends FilterBase {
    
    /**
     * {@inheritdoc}
     */
    public function process($text, $langcode) {
        $result = new FilterProcessResult($text);
        $metadata = new CacheableMetadata();
        $metadata->addCacheTags([
            'merge:tag',
        ]);
        $metadata->addCacheContexts([
            'user.permissions',
        ]);
        $result = $result->merge($metadata);
        return $result;
    }

}

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.
FilterTestCacheMerge::process public function Performs the filter processing. Overrides FilterInterface::process
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.