You are here

Home » API reference » Cookie Content Blocker 8 » CookieContentBlockerFilter.php

class CookieContentBlockerFilter in Cookie Content Blocker 8

Text filter that converts custom HTML tags into markup.

Plugin annotation


@Filter(
  id = "cookie_content_blocker_filter",
  title = @Translation("Cookie content blocker filter"),
  description = @Translation("This filter converts Cookie content blocker's custom HTML tags into markup and handles blocking of wrapped HTML/Text. It is recommended to run this filter last."),
  type = \Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
)

Hierarchy

Expanded class hierarchy of CookieContentBlockerFilter

File

src/Plugin/Filter/CookieContentBlockerFilter.php, line 29

Namespace

Drupal\cookie_content_blocker\Plugin\Filter
View source 
class CookieContentBlockerFilter extends FilterBase implements ContainerFactoryPluginInterface {

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  private $renderer;

  /**
   * Construct a CookieContentBlockerFilter plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, RendererInterface $renderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : CookieContentBlockerFilter {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) : FilterProcessResult {
    $result = new FilterProcessResult($text);
    if (empty($text)) {
      return $result;
    }
    return $result
      ->setProcessedText($this
      ->replaceTags($text));
  }

  /**
   * Replaces cookie content blocker tags for the given text.
   *
   * @param string $text
   *   The HTML/Text where we want to replace tags for.
   *
   * @return string
   *   The text with tags replaced.
   */
  private function replaceTags(string $text) : string {
    [
      $matches,
      $settings,
      $content,
    ] = $this
      ->matchTags($text);
    if (empty($matches)) {
      return $text;
    }
    foreach ($matches as $index => $match) {
      if (empty($content[$index])) {
        continue;
      }
      $blocker_settings = isset($settings[$index]) ? $this
        ->decodeSettings($settings[$index]) : [];
      $blocked_content_element = [
        // We depend on other filters to have sanitized the content.
        '#markup' => Markup::create($content[$index]),
        '#pre_render' => [
          'cookie_content_blocker.element.processor:processElement',
        ],
        '#cookie_content_blocker' => $blocker_settings ?: TRUE,
      ];
      $text = str_replace($match, $this->renderer
        ->renderPlain($blocked_content_element), $text);
    }
    return $text;
  }

  /**
   * Match all our custom HTML element nodes with their settings and children.
   *
   * We use our own custom HTML element node '<cookiecontentblocker>'
   * using a node element makes it easier to work with in WYSIWYG editors.
   *
   * @param string $text
   *   The HTML/Text string.
   *
   * @return array
   *   A keyed array containing:
   *    - (0) Array of full pattern matches.
   *    - (1) Array of strings defining settings for each associated match.
   *    - (2) Array of strings defining the content for each associated match.
   */
  private function matchTags(string $text) : array {
    preg_match_all('/<cookiecontentblocker.*?(?:data-settings="(.*?)".*?)*?>(.*?)<\\/cookiecontentblocker>/s', $text, $matches);
    return [
      $matches[0],
      $matches[1],
      $matches[2],
    ];
  }

  /**
   * Decode a encoded settings string to a settings array.
   *
   * @param string $settings
   *   The settings string to decode.
   *
   * @return array
   *   The decoded settings or an empty array if decoding failed.
   */
  private function decodeSettings(string $settings) : array {

    // Check if we need to decode the settings first. This way we support
    // both base64 encoded strings and settings already in a JSON-string format.
    $decoded_settings = base64_decode($settings);
    $needs_decode = base64_encode($decoded_settings) === $settings;
    if ($needs_decode && is_string($decoded_settings)) {
      $settings = $decoded_settings;
    }
    $settings = Xss::filter($settings, []);
    $settings = json_decode($settings, TRUE);
    return $settings ?: [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CookieContentBlockerFilter::$renderer private property The renderer.
CookieContentBlockerFilter::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CookieContentBlockerFilter::decodeSettings private function Decode a encoded settings string to a settings array.
CookieContentBlockerFilter::matchTags private function Match all our custom HTML element nodes with their settings and children.
CookieContentBlockerFilter::process public function Performs the filter processing. Overrides FilterInterface::process
CookieContentBlockerFilter::replaceTags private function Replaces cookie content blocker tags for the given text.
CookieContentBlockerFilter::__construct public function Construct a CookieContentBlockerFilter plugin. Overrides FilterBase::__construct
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 1
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 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
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.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.