CkeditorImagesGallery.php in CKEditor Images Gallery 8

Namespace

Drupal\ckeditor_images_gallery\Plugin\CKEditorPlugin

File

src/Plugin/CKEditorPlugin/CkeditorImagesGallery.php

<?php

namespace Drupal\ckeditor_images_gallery\Plugin\CKEditorPlugin;

use Drupal\ckeditor\CKEditorPluginBase;
use Drupal\editor\Entity\Editor;

/**
 * Defines the "images_gallery" plugin.
 *
 * NOTE: The plugin ID ('id' key) corresponds to the CKEditor plugin name.
 * It is the first argument of the CKEDITOR.plugins.add() function in the
 * plugin.js file.
 *
 * @CKEditorPlugin(
 *   id = "images_gallery",
 *   label = @Translation("Images gallery ckeditor button")
 * )
 */
class CkeditorImagesGallery extends CKEditorPluginBase {

  /**
   * {@inheritdoc}
   *
   * NOTE: The keys of the returned array corresponds to the CKEditor button
   * names. They are the first argument of the editor.ui.addButton() or
   * editor.ui.addRichCombo() functions in the plugin.js file.
   */
  public function getButtons() {

    // Make sure that the path to the image matches the file structure of
    // the CKEditor plugin you are implementing.
    return [
      'Gallery' => [
        'label' => t('Images gallery'),
        'image' => 'modules/ckeditor_images_gallery/js/plugins/images_gallery/icons/gallery.png',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFile() {

    // Make sure that the path to the plugin.js matches the file structure of
    // the CKEditor plugin you are implementing.
    return drupal_get_path('module', 'ckeditor_images_gallery') . '/js/plugins/images_gallery/plugin.js';
  }

  /**
   * {@inheritdoc}
   */
  public function isInternal() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getDependencies(Editor $editor) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(Editor $editor) {
    return [
      'ckeditor_images_gallery/ckeditor.images_gallery.dialog',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    return [];
  }

}

Classes

Name	Description
CkeditorImagesGallery	Defines the "images_gallery" plugin.