class UnicornEditor

Same name in other branches
  1. 9 core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php \Drupal\editor_test\Plugin\Editor\UnicornEditor
  2. 8.9.x core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php \Drupal\editor_test\Plugin\Editor\UnicornEditor
  3. 10 core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php \Drupal\editor_test\Plugin\Editor\UnicornEditor

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

Hierarchy

Expanded class hierarchy of UnicornEditor

File

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

Namespace

Drupal\editor_test\Plugin\Editor
View source 
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',
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
EditorBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 1
EditorBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 7
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3
UnicornEditor::buildConfigurationForm public function Form constructor. Overrides EditorBase::buildConfigurationForm
UnicornEditor::getDefaultSettings public function Returns the default settings for this configurable text editor. Overrides EditorBase::getDefaultSettings
UnicornEditor::getJSSettings public function Returns JavaScript settings to be attached. Overrides EditorPluginInterface::getJSSettings
UnicornEditor::getLibraries public function Returns libraries to be attached. Overrides EditorPluginInterface::getLibraries
UnicornEditor::validateImageUploadSettings public function #element_validate handler for "image_upload" in buildConfigurationForm().

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