class CodeMirrorEditor in The CodeMirror Editor 8

Defines a CodeMirror text editor.

Plugin annotation

@Editor(
  id = "codemirror_editor",
  label = @Translation("CodeMirror editor"),
  supports_content_filtering = FALSE,
  is_xss_safe = FALSE,
  supported_element_types = {
    "textarea",
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\editor\Plugin\EditorBase implements EditorPluginInterface
      • class \Drupal\codemirror_editor\Plugin\Editor\CodeMirrorEditor uses CodeMirrorPluginTrait

File

src/Plugin/Editor/CodeMirrorEditor.php, line 23

Namespace

Drupal\codemirror_editor\Plugin\Editor

class CodeMirrorEditor extends EditorBase {
  use CodeMirrorPluginTrait;

  /**
   * {@inheritdoc}
   */
  public function getDefaultSettings() {
    return self::getDefaultCodeMirrorSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return self::buildCodeMirrorSettingsForm($form_state
      ->get('editor')
      ->getSettings());
  }

  /**
   * {@inheritdoc}
   */
  public function getJsSettings(Editor $editor) {
    return $editor
      ->getSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(Editor $editor) {
    return [
      'codemirror_editor/editor',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CodeMirrorEditor::buildConfigurationForm	public	function	Form constructor. Overrides EditorBase::buildConfigurationForm
CodeMirrorEditor::getDefaultSettings	public	function	Returns the default settings for this configurable text editor. Overrides EditorBase::getDefaultSettings
CodeMirrorEditor::getJsSettings	public	function
CodeMirrorEditor::getLibraries	public	function	Returns libraries to be attached. Overrides EditorPluginInterface::getLibraries
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
EditorBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	1
EditorBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
EditorPluginInterface::getJSSettings	public	function	Returns JavaScript settings to be attached.	4
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.