UnicornEditor.php

Same filename and directory in other branches
  1. 9 core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php
  2. 8.9.x core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php
  3. 11.x core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php

Namespace

Drupal\editor_test\Plugin\Editor

File

core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php

View source
<?php

namespace Drupal\editor_test\Plugin\Editor;

use Drupal\Core\Form\FormStateInterface;
use Drupal\editor\Attribute\Editor;
use Drupal\editor\Entity\Editor as EditorEntity;
use Drupal\editor\Plugin\EditorBase;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Defines a Unicorn-powered text editor for Drupal (for testing purposes).
 */
class UnicornEditor extends EditorBase {
  
  /**
   * {@inheritdoc}
   */
  public function getDefaultSettings() {
    return [
      'ponies_too' => TRUE,
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['ponies_too'] = [
      '#title' => $this->t('Pony mode'),
      '#type' => 'checkbox',
      '#default_value' => TRUE,
    ];
    $form_state->loadInclude('editor', 'admin.inc');
    $form['image_upload'] = editor_image_upload_settings_form($form_state->get('editor'));
    $form['image_upload']['#element_validate'][] = [
      $this,
      'validateImageUploadSettings',
    ];
    return $form;
  }
  
  /**
   * #element_validate handler for "image_upload" in buildConfigurationForm().
   *
   * Moves the text editor's image upload settings into $editor->image_upload.
   *
   * @see editor_image_upload_settings_form()
   */
  public function validateImageUploadSettings(array $element, FormStateInterface $form_state) {
    $settings =& $form_state->getValue([
      'editor',
      'settings',
      'image_upload',
    ]);
    $form_state->get('editor')
      ->setImageUploadSettings($settings);
    $form_state->unsetValue([
      'editor',
      'settings',
      'image_upload',
    ]);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getJSSettings(EditorEntity $editor) {
    $js_settings = [];
    $settings = $editor->getSettings();
    if ($settings['ponies_too']) {
      $js_settings['ponyModeEnabled'] = TRUE;
    }
    return $js_settings;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getLibraries(EditorEntity $editor) {
    return [
      'editor_test/unicorn',
    ];
  }

}

Classes

Title Deprecated Summary
UnicornEditor Defines a Unicorn-powered text editor for Drupal (for testing purposes).

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