public function DrupalImageCaption::getConfig in Zircon Profile 8.0

Same name and namespace in other branches

8 core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImageCaption::getConfig()

Returns the additions to CKEDITOR.config for a specific CKEditor instance.

The editor's settings can be retrieved via $editor->getSettings(), but be aware that it may not yet contain plugin-specific settings, because the user may not yet have configured the form. If there are plugin-specific settings (verify with isset()), they can be found at

$settings = $editor
  ->getSettings();
$plugin_specific_settings = $settings['plugins'][$plugin_id];

Parameters

\Drupal\editor\Entity\Editor $editor: A configured text editor object.

Return value

array A keyed array, whose keys will end up as keys under CKEDITOR.config.

Overrides CKEditorPluginInterface::getConfig

File

core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php, line 59: Contains \Drupal\ckeditor\Plugin\CKEditorPlugin\DrupalImageCaption.

Class

DrupalImageCaption: Defines the "drupalimagecaption" plugin.

Namespace

Drupal\ckeditor\Plugin\CKEditorPlugin

Code

public function getConfig(Editor $editor) {
  $format = $editor
    ->getFilterFormat();
  return array(
    'image2_captionedClass' => 'caption caption-img',
    'image2_alignClasses' => array(
      'align-left',
      'align-center',
      'align-right',
    ),
    'drupalImageCaption_captionPlaceholderText' => t('Enter caption here'),
    // Only enable those parts of DrupalImageCaption for which the
    // corresponding Drupal text filters are enabled.
    'drupalImageCaption_captionFilterEnabled' => $format
      ->filters('filter_caption')->status,
    'drupalImageCaption_alignFilterEnabled' => $format
      ->filters('filter_align')->status,
  );
}

You are here