You are here

Home » API reference » Syntax Highlighter 8 » FilterSyntaxHighlighter.php

class FilterSyntaxHighlighter in Syntax Highlighter 8

Provides a filter to highlight source code.

Plugin annotation


@Filter(
  id = "filter_syntaxhighlighter",
  title = @Translation("Syntax Highlighter"),
  description = @Translation("Allow highlighting source code using the SyntaxHighlighter Javascript library"),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE,
)

Hierarchy

Expanded class hierarchy of FilterSyntaxHighlighter

File

src/Plugin/Filter/FilterSyntaxHighlighter.php, line 18

Namespace

Drupal\syntaxhighlighter\Plugin\Filter
View source 
class FilterSyntaxHighlighter extends FilterBase {

  /**
   * Escape the content text in preparation for filtering.
   *
   *  - Change all syntaxhighlighter <pre> tag pairs to
   *    {-_sYnTaXhIgHlIgHtEr_-} {/-_sYnTaXhIgHlIgHtEr_-} pair (so other
   *    filters would not mess with them.
   *
   * Precondition: all the open/close tags much match because search is done
   * on a pair by pair basis. If match is not even, do nothing.
   *
   * All HTML tags and entities inside the SyntaxHighlighter must be properly
   * escaped.
   *
   * For example, in HTML code, change:
   *
   *  - '<' to '&lt;': e.g.  <pre> -> &lt;pre>, <html> -> &lt;html>
   *  - neutralize & in entity: e.g.: &gt; -> &amp;gt;
   *
   * {@inheritdoc}
   */
  public function prepare($text, $langcode) {
    $config = \Drupal::config('syntaxhighlighter.settings');
    $tag_name = $config
      ->get('tagname');
    $pattern = "#<{$tag_name}\\s*([^>]*)>|</\\s*{$tag_name}>#";
    preg_match_all($pattern, $text, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER);
    $output = '';
    $at = 0;
    $n = count($matches);

    // Do nothing if open/close tag match is not even.
    if ($n % 2 !== 0) {
      return $text;
    }
    for ($i = 0; $i < $n; $i += 2) {
      $open_tag = $matches[$i];
      $close_tag = $matches[$i + 1];
      if (strpos($open_tag[1][0], 'brush:')) {
        $output .= substr($text, $at, $open_tag[0][1] - $at);
        $begin = $open_tag[0][1] + strlen($open_tag[0][0]);
        $length = $close_tag[0][1] - $begin;
        $output .= '{' . SYNTAXHIGHLIGHTER_TAG_STRING . ' ' . $open_tag[1][0] . '}' . substr($text, $begin, $length) . '{/' . SYNTAXHIGHLIGHTER_TAG_STRING . '}';
        $at = $close_tag[0][1] + strlen($close_tag[0][0]);
      }
    }
    $output .= substr($text, $at);
    return $output;
  }

  /**
   * Revert back to <pre> tag.
   *
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $config = \Drupal::config('syntaxhighlighter.settings');
    $patterns = [
      '#{' . SYNTAXHIGHLIGHTER_TAG_STRING . ' ([^}]+)}#',
      '#{/' . SYNTAXHIGHLIGHTER_TAG_STRING . '}#',
    ];
    $tag_name = $config
      ->get('tagname');
    $replacements = [
      "<{$tag_name} \$1>",
      "</{$tag_name}>",
    ];
    $output = preg_replace($patterns, $replacements, $text);
    return new FilterProcessResult($output);
  }

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    return _syntaxhighlighter_filter_tips(0, 0, TRUE);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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.
FilterSyntaxHighlighter::prepare public function Escape the content text in preparation for filtering. Overrides FilterBase::prepare
FilterSyntaxHighlighter::process public function Revert back to <pre> tag. Overrides FilterInterface::process
FilterSyntaxHighlighter::tips public function Generates a filter's tip. Overrides FilterBase::tips
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.