class UnicornEditor in Zircon Profile 8.0

Defines a Unicorn-powered text editor for Drupal (for testing purposes).

Plugin annotation

@Editor(
  id = "unicorn",
  label = @Translation("Unicorn Editor"),
  supports_content_filtering = TRUE,
  supports_inline_editing = TRUE,
  is_xss_safe = FALSE,
  supported_element_types = {
    "textarea",
    "textfield",
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\editor\Plugin\EditorBase implements EditorPluginInterface
      • class \Drupal\editor_test\Plugin\Editor\UnicornEditor

File

core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php, line 29

Contains \Drupal\editor_test\Plugin\Editor\UnicornEditor.

Namespace

Drupal\editor_test\Plugin\Editor

class UnicornEditor extends EditorBase {

  /**
   * {@inheritdoc}
   */
  function getDefaultSettings() {
    return array(
      'ponies_too' => TRUE,
    );
  }

  /**
   * {@inheritdoc}
   */
  function settingsForm(array $form, FormStateInterface $form_state, EditorEntity $editor) {
    $form['ponies_too'] = array(
      '#title' => t('Pony mode'),
      '#type' => 'checkbox',
      '#default_value' => TRUE,
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  function getJSSettings(EditorEntity $editor) {
    $js_settings = array();
    $settings = $editor
      ->getSettings();
    if ($settings['ponies_too']) {
      $js_settings['ponyModeEnabled'] = TRUE;
    }
    return $js_settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(EditorEntity $editor) {
    return array(
      'editor_test/unicorn',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::settingsFormSubmit	public	function	Modifies any values in the form state to prepare them for saving. Overrides EditorPluginInterface::settingsFormSubmit	1
EditorBase::settingsFormValidate	public	function	Validates the settings form for an editor. Overrides EditorPluginInterface::settingsFormValidate
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.
UnicornEditor::getDefaultSettings		function	Returns the default settings for this configurable text editor. Overrides EditorBase::getDefaultSettings
UnicornEditor::getJSSettings		function	Returns JavaScript settings to be attached. Overrides EditorPluginInterface::getJSSettings
UnicornEditor::getLibraries	public	function	Returns libraries to be attached. Overrides EditorPluginInterface::getLibraries
UnicornEditor::settingsForm		function	Returns a settings form to configure this text editor. Overrides EditorBase::settingsForm