class DrupalImage in Drupal 10

Defines the "drupalimage" plugin.

Plugin annotation

@CKEditorPlugin(
  id = "drupalimage",
  label = @Translation("Image"),
  module = "ckeditor"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface
      • class \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImage implements CKEditorPluginConfigurableInterface

12 string references to 'DrupalImage'

CKEditor5AllowedTagsTest::testImageUploadsRemainEnabled in core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php

Tests that when image uploads are enabled in CKEditor 4, they remain in 5.

CKEditor::getDefaultSettings in core/modules/ckeditor/src/Plugin/Editor/CKEditor.php

CKEditorAdminTest::testExistingFormat in core/modules/ckeditor/tests/src/Functional/CKEditorAdminTest.php

Tests configuring a text editor for an existing text format.

CKEditorTest::getDefaultToolbarConfig in core/modules/ckeditor/tests/src/Kernel/CKEditorTest.php

Core::mapCKEditor4ToolbarButtonToCKEditor5ToolbarItem in core/modules/ckeditor5/src/Plugin/CKEditor4To5Upgrade/Core.php

... See full list

File

core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImage.php, line 19

Namespace

Drupal\ckeditor\Plugin\CKEditorPlugin

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',
    ]);
  }

}