DrupalImage.php

Same filename in other branches
  1. 8.9.x core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImage.php

Namespace

Drupal\ckeditor\Plugin\CKEditorPlugin

File

core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImage.php

View source
<?php

namespace Drupal\ckeditor\Plugin\CKEditorPlugin;

use Drupal\ckeditor\CKEditorPluginBase;
use Drupal\ckeditor\CKEditorPluginConfigurableInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\editor\Entity\Editor;

/**
 * Defines the "drupalimage" plugin.
 *
 * @CKEditorPlugin(
 *   id = "drupalimage",
 *   label = @Translation("Image"),
 *   module = "ckeditor"
 * )
 */
class DrupalImage extends CKEditorPluginBase implements CKEditorPluginConfigurableInterface {
    
    /**
     * {@inheritdoc}
     */
    public function getFile() {
        return $this->getModulePath('ckeditor') . '/js/plugins/drupalimage/plugin.js';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getLibraries(Editor $editor) {
        return [
            'core/drupal.ajax',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfig(Editor $editor) {
        return [
            'drupalImage_dialogTitleAdd' => $this->t('Insert Image'),
            'drupalImage_dialogTitleEdit' => $this->t('Edit Image'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getButtons() {
        return [
            'DrupalImage' => [
                'label' => $this->t('Image'),
                'image' => $this->getModulePath('ckeditor') . '/js/plugins/drupalimage/icons/drupalimage.png',
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     *
     * @see \Drupal\editor\Form\EditorImageDialog
     * @see editor_image_upload_settings_form()
     */
    public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
        $form_state->loadInclude('editor', 'admin.inc');
        $form['image_upload'] = editor_image_upload_settings_form($editor);
        $form['image_upload']['#attached']['library'][] = 'ckeditor/drupal.ckeditor.drupalimage.admin';
        $form['image_upload']['#element_validate'][] = [
            $this,
            'validateImageUploadSettings',
        ];
        return $form;
    }
    
    /**
     * #element_validate handler for the "image_upload" element in settingsForm().
     *
     * Moves the text editor's image upload settings from the DrupalImage plugin's
     * own settings into $editor->image_upload.
     *
     * @see \Drupal\editor\Form\EditorImageDialog
     * @see editor_image_upload_settings_form()
     */
    public function validateImageUploadSettings(array $element, FormStateInterface $form_state) {
        $settings =& $form_state->getValue([
            'editor',
            'settings',
            'plugins',
            'drupalimage',
            'image_upload',
        ]);
        $form_state->get('editor')
            ->setImageUploadSettings($settings);
        $form_state->unsetValue([
            'editor',
            'settings',
            'plugins',
            'drupalimage',
        ]);
    }

}

Classes

Title Deprecated Summary
DrupalImage Defines the "drupalimage" plugin.

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