class Bgimage in CkEditor Background Image 8

Defines the "bgimage" plugin.

Plugin annotation

@CKEditorPlugin(
  id = "bgimage",
  label = @Translation("Background Image")
)

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_bgimage\Plugin\CKEditorPlugin\Bgimage implements CKEditorPluginConfigurableInterface

File

src/Plugin/CKEditorPlugin/Bgimage.php, line 18

Namespace

Drupal\ckeditor_bgimage\Plugin\CKEditorPlugin

class Bgimage extends CKEditorPluginBase implements CKEditorPluginConfigurableInterface {

  /**
   * {@inheritdoc}
   */
  public function getFile() {
    if ($module_path = drupal_get_path('module', 'ckeditor_bgimage')) {
      return $module_path . '/src/js/bgimage/plugin.js';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(Editor $editor) {
    return [
      'core/drupal.ajax',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    return [
      'bgimage_dialogTitleAdd' => $this
        ->t('Background Image'),
      'bgimage_dialogTitleEdit' => $this
        ->t('Edit File'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getButtons() {
    return [
      'bgimage' => [
        'label' => $this
          ->t('Background Image'),
        'image' => drupal_get_path('module', 'ckeditor_bgimage') . '/src/js/bgimage/icons/background.png',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   *
   * @see \Drupal\editor\Form\EditorFileDialog
   * @see ckeditor_bgimage_upload_settings_form()
   */
  public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
    $form_state
      ->loadInclude('ckeditor_bgimage', 'admin.inc');
    $form['file_upload'] = ckeditor_bgimage_upload_settings_form($editor);
    $form['file_upload']['#attached']['library'][] = 'ckeditor_bgimage/drupal.ckeditor.ckeditor_bgimage.admin';
    $form['file_upload']['#element_validate'][] = [
      $this,
      'validateFileUploadSettings',
    ];
    return $form;
  }

  /**
   * Element_validate handler for the "file_upload" element in settingsForm().
   *
   * Moves the text editor's file upload settings
   * from the bgimage plugin's
   * own settings into $editor->file_upload.
   *
   * @see \Drupal\editor\Form\EditorFileDialog
   * @see ckeditor_bgimage_upload_settings_form()
   */
  public function validateFileUploadSettings(array $element, FormStateInterface $form_state) {
    $settings =& $form_state
      ->getValue([
      'editor',
      'settings',
      'plugins',
      'bgimage',
      'file_upload',
    ]);
    $editor = $form_state
      ->get('editor');
    foreach ($settings as $key => $value) {
      if (!empty($value)) {
        $editor
          ->setThirdPartySetting('ckeditor_bgimage', $key, $value);
      }
      else {
        $editor
          ->unsetThirdPartySetting('ckeditor_bgimage', $key);
      }
    }
    $form_state
      ->unsetValue([
      'editor',
      'settings',
      'plugins',
      'bgimage',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Bgimage::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
Bgimage::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
Bgimage::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
Bgimage::getLibraries	public	function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginBase::getLibraries
Bgimage::settingsForm	public	function	Overrides CKEditorPluginConfigurableInterface::settingsForm
Bgimage::validateFileUploadSettings	public	function	Element_validate handler for the "file_upload" element in settingsForm().
CKEditorPluginBase::getDependencies	public	function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies	1
CKEditorPluginBase::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.