class CodeMirrorEditor in The CodeMirror Editor 8

Provides a 'CodeMirror' filter.

Plugin annotation

@Filter(
  id = "codemirror_editor",
  title = @Translation("CodeMirror"),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
  settings = {
    "lineWrapping" = false,
    "lineNumbers" = true,
    "foldGutter" = false
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\filter\Plugin\FilterBase implements FilterInterface
      • class \Drupal\codemirror_editor\Plugin\Filter\CodeMirrorEditor uses CodeMirrorPluginTrait

File

src/Plugin/Filter/CodeMirrorEditor.php, line 25

Namespace

Drupal\codemirror_editor\Plugin\Filter

class CodeMirrorEditor extends FilterBase {
  use CodeMirrorPluginTrait;

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $keys = [
      'lineWrapping',
      'lineNumbers',
      'foldGutter',
    ];
    return self::buildCodeMirrorSettingsForm($this->settings, $keys);
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $options = $this->settings;
    $options['readOnly'] = TRUE;
    $options['toolbar'] = FALSE;
    $pattern = '#<code\\s+?data-mode\\s*?=\\s*?"([a-z0-9_/\\-]*?)"[^>]*?>(.*?)</\\s*code\\s*>#is';
    $processor = function ($matches) use ($options) {
      $options['mode'] = self::normalizeMode($matches[1]);
      $options = Html::escape(json_encode($options));
      $code = Html::escape($matches[2]);
      return '<code data-codemirror="' . $options . '">' . $code . '</code>';
    };
    $output = preg_replace_callback($pattern, $processor, $text, -1, $count);
    if ($count > 0) {
      $build['#attached']['library'][] = 'codemirror_editor/formatter';
      \Drupal::service('renderer')
        ->render($build);
    }
    return new FilterProcessResult($output);
  }

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    $tip_arguments = [
      '@expression' => '<code data-mode="mode">...</code>',
    ];
    return $this
      ->t('Syntax highlight code surrounded by the <code>@expression</code> tags.', $tip_arguments);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CodeMirrorEditor::process	public	function	Performs the filter processing. Overrides FilterInterface::process
CodeMirrorEditor::settingsForm	public	function	Generates a filter's settings form. Overrides FilterBase::settingsForm
CodeMirrorEditor::tips	public	function	Generates a filter's tip. Overrides FilterBase::tips
CodeMirrorPluginTrait::buildCodeMirrorSettingsForm	protected static	function	Returns a form to configure settings for the CodeMirror plugin.
CodeMirrorPluginTrait::formatBoolean	protected	function	Returns formatted boolean setting value.
CodeMirrorPluginTrait::getAvailableButtons	protected static	function	Returns a list of buttons available for CodeMirror.
CodeMirrorPluginTrait::getDefaultCodeMirrorSettings	protected static	function	Returns the default settings for CodeMirror plugin.
CodeMirrorPluginTrait::normalizeMode	protected static	function	Normalizes language mode.
CodeMirrorPluginTrait::setButtonsValue	public static	function	Value callback for CodeMirror buttons.
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::__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.	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.