You are here

Home » API reference » Custom filter 2.0.x » CustomFilterBaseFilter.php

class CustomFilterBaseFilter in Custom filter 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Filter/CustomFilterBaseFilter.php \Drupal\customfilter\Plugin\Filter\CustomFilterBaseFilter

Provides a base filter for Custom Filter.

No annotation here, see info alter hook.

Hierarchy

Expanded class hierarchy of CustomFilterBaseFilter

See also

\customfilter_filter_info_alter

File

src/Plugin/Filter/CustomFilterBaseFilter.php, line 16

Namespace

Drupal\customfilter\Plugin\Filter
View source 
class CustomFilterBaseFilter extends FilterBase {

  /**
   * Performs the filter processing.
   *
   * @param string $text
   *   The text string to be filtered.
   * @param string $langcode
   *   The language code of the text to be filtered.
   */
  public function process($text, $langcode) {

    // If the text passed is an empty string, then return it immediately.
    if (empty($text)) {
      return new FilterProcessResult();
    }

    /** @var \Drupal\customfilter\Entity\CustomFilter $entity */
    $entity = CustomFilter::load($this->settings['id']);
    $globals =& static::getGlobals('push');
    $globals->text = $text;
    $rules = $entity
      ->getRulesTree();
    if (is_array($rules) && count($rules)) {

      // Reset the object containing the global variables.
      static::getCodeVars(TRUE);

      // Prepare the stack used to save the parent rule.
      $globals->stack = [];
      foreach ($rules as $rule) {
        if ($rule['enabled']) {
          $globals->stack[] = $rule;
          $globals->text = preg_replace_callback($rule['pattern'], [
            CustomFilterBaseFilter::class,
            'applyRules',
          ], $globals->text);
          array_pop($globals->stack);
        }
      }
    }
    $text = $globals->text;
    static::getGlobals('pop');
    $result = new FilterProcessResult($text);
    $result
      ->addCacheTags($entity
      ->getCacheTagsToInvalidate());
    if (!$entity
      ->getCache()) {
      $result
        ->setCacheMaxAge(0);
    }
    return $result;
  }

  /**
   * Get the tips for the filter.
   *
   * @param bool $long
   *   If get the long or short tip.
   *
   * @return string
   *   The tip to show for the user.
   */
  public function tips($long = FALSE) {
    $entity = CustomFilter::load($this->settings['id']);
    if ($long) {
      return $entity
        ->getLongtip();
    }
    else {
      return $entity
        ->getShorttip();
    }
  }

  /**
   * Replace the text using rules.
   *
   * @param array $matches
   *   The text match by regular expression.
   *
   * @return string
   *   The text after rules have beem apply.
   */
  public static function applyRules(array $matches) {
    $globals =& static::getGlobals();
    $result = $matches[0];
    $rule = end($globals->stack);
    $code = $rule['code'];
    $pattern = $rule['pattern'];
    $replacement = $rule['replacement'];
    if (is_array($sub = $rule['sub']) && count($sub)) {
      foreach ($sub as $subrule) {
        if ($subrule['enabled']) {
          $globals->stack[] = $subrule;
          $substr =& $matches[$subrule['matches']];
          $substr = preg_replace_callback($subrule['pattern'], [
            CustomFilterBaseFilter::class,
            'applyRules',
          ], $substr);
          array_pop($globals->stack);
        }
      }
      if ($code) {
        CustomFilterBaseFilter::replaceCallback($replacement, TRUE);
        $result = CustomFilterBaseFilter::replaceCallback($matches);
      }
      else {
        $result = $replacement;
        $rmatches = [];
        $reps = [];
        preg_match_all('/([^\\\\]|^)(\\$([0-9]{1,2}|\\{([0-9]{1,2})\\}))/', $replacement, $rmatches, PREG_OFFSET_CAPTURE | PREG_UNMATCHED_AS_NULL);
        foreach ($rmatches[4] as $key => $val) {
          if ($val == '') {
            $index = $rmatches[3][$key][0];
          }
          else {

            // To support PHP7.4: see [#3151616].
            $index = $rmatches[4][$key][1] != -1 ? $rmatches[4][$key][0] : $rmatches[3][$key][0];
          }
          $offset = $rmatches[2][$key][1];
          $length = strlen($rmatches[2][$key][0]);
          $reps[] = [
            'index' => intval($index),
            'offset' => $offset,
            'length' => $length,
          ];
        }
        krsort($reps);
        foreach ($reps as $rep) {
          $result = substr_replace($result, $matches[$rep['index']], $rep['offset'], $rep['length']);
        }
      }
    }
    elseif ($code) {
      CustomFilterBaseFilter::replaceCallback($replacement, TRUE);
      $result = preg_replace_callback($pattern, [
        CustomFilterBaseFilter::class,
        'replaceCallback',
      ], $result);
    }
    else {
      $result = preg_replace($pattern, $replacement, $result);
    }
    return $result;
  }

  /**
   * Helper function for preg_replace_callback().
   */
  public static function replaceCallback($matches, $init = FALSE) {
    static $code;
    if ($init) {
      $code = $matches;
      return '';
    }
    static::getCodeVars();

    // phpcs:ignore
    @eval($code);
    return isset($result) ? $result : '';
  }

  /**
   * Return the global object containing the global properties.
   *
   * Return the global object containing the global properties used in the
   * replacement PHP code.
   *
   * @param bool $reset
   *   Boolean value set to TRUE when the global object must be reset.
   */
  public static function &getCodeVars($reset = FALSE) {
    static $vars;
    if (!isset($vars) || $reset) {
      $vars = new \stdClass();
    }
    return $vars;
  }

  /**
   * Return an object with global variables used during the execution of a rule.
   */
  public static function &getGlobals($op = '') {
    static $globals = [], $index = 0;
    if ($op == 'push') {
      $globals[++$index] = new \stdClass();
    }
    elseif ($op == 'pop' && $index) {
      unset($globals[$index--]);
    }
    return $globals[$index];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CustomFilterBaseFilter::applyRules public static function Replace the text using rules.
CustomFilterBaseFilter::getCodeVars public static function Return the global object containing the global properties.
CustomFilterBaseFilter::getGlobals public static function Return an object with global variables used during the execution of a rule.
CustomFilterBaseFilter::process public function Performs the filter processing. Overrides FilterInterface::process
CustomFilterBaseFilter::replaceCallback public static function Helper function for preg_replace_callback().
CustomFilterBaseFilter::tips public function Get the tips for the filter. Overrides FilterBase::tips
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
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 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::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 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.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 4
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.