class TRexEditor

Same name and namespace in other branches

9 core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/TRexEditor.php \Drupal\editor_test\Plugin\Editor\TRexEditor
8.9.x core/modules/editor/tests/modules/src/Plugin/Editor/TRexEditor.php \Drupal\editor_test\Plugin\Editor\TRexEditor
10 core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/TRexEditor.php \Drupal\editor_test\Plugin\Editor\TRexEditor

Defines a Tyrannosaurus-Rex powered text editor for testing purposes.

Attributes

#[Editor(id: 'trex', label: new TranslatableMarkup('TRex Editor'), supports_content_filtering: TRUE, supports_inline_editing: TRUE, is_xss_safe: FALSE, supported_element_types: [ 'textarea', ])]

Hierarchy

class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
  - class \Drupal\editor\Plugin\EditorBase extends \Drupal\editor\Plugin\EditorPluginInterface implements \Drupal\Core\Plugin\PluginBase
    - class \Drupal\editor_test\Plugin\Editor\TRexEditor implements \Drupal\editor\Plugin\EditorBase

Expanded class hierarchy of TRexEditor

File

core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/TRexEditor.php, line 16

Namespace

Drupal\editor_test\Plugin\Editor

View on git.drupalcode.org

View source

class TRexEditor extends EditorBase {
  
  /**
   * {@inheritdoc}
   */
  public function getDefaultSettings() {
    return [
      'stumpy_arms' => TRUE,
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['stumpy_arms'] = [
      '#title' => $this->t('Stumpy arms'),
      '#type' => 'checkbox',
      '#default_value' => TRUE,
    ];
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getJSSettings(EditorEntity $editor) {
    $js_settings = [];
    $settings = $editor->getSettings();
    if ($settings['stumpy_arms']) {
      $js_settings['doMyArmsLookStumpy'] = TRUE;
    }
    return $js_settings;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getLibraries(EditorEntity $editor) {
    return [
      'editor_test/trex',
    ];
  }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	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			3
DependencySerializationTrait::__wakeup		public	function			3
EditorBase::submitConfigurationForm		public	function	Form submission handler.	Overrides PluginFormInterface::submitConfigurationForm	1
EditorBase::validateConfigurationForm		public	function	Form validation handler.	Overrides PluginFormInterface::validateConfigurationForm	1
MessengerTrait::$messenger		protected	property	The messenger.		25
MessengerTrait::messenger		public	function	Gets the messenger.		25
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	Deprecated	public	function	Determines if the plugin is configurable.
PluginBase::__construct		public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.		82
StringTranslationTrait::$stringTranslation		protected	property	The string translation service.		3
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.		1
TRexEditor::buildConfigurationForm		public	function	Form constructor.	Overrides EditorBase::buildConfigurationForm
TRexEditor::getDefaultSettings		public	function	Returns the default settings for this configurable text editor.	Overrides EditorBase::getDefaultSettings
TRexEditor::getJSSettings		public	function	Returns JavaScript settings to be attached.	Overrides EditorPluginInterface::getJSSettings
TRexEditor::getLibraries		public	function	Returns libraries to be attached.	Overrides EditorPluginInterface::getLibraries

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.

Breadcrumb