class CustomConfig in CKEditor custom config 8.2

Defines the "customconfig" plugin.

Plugin annotation

@CKEditorPlugin(
  id = "customconfig",
  label = @Translation("CKEditor custom configuration")
)

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_config\Plugin\CKEditorPlugin\CustomConfig implements CKEditorPluginConfigurableInterface, CKEditorPluginContextualInterface

File

src/Plugin/CKEditorPlugin/CustomConfig.php, line 19

Namespace

Drupal\ckeditor_config\Plugin\CKEditorPlugin

class CustomConfig extends CKEditorPluginBase implements CKEditorPluginConfigurableInterface, CKEditorPluginContextualInterface {

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

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

  /**
   * {@inheritdoc}
   */
  public function isEnabled(Editor $editor) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getButtons() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    $config = [];
    $settings = $editor
      ->getSettings();
    if (!isset($settings['plugins']['customconfig']['ckeditor_custom_config'])) {
      return $config;
    }
    $custom_config = $settings['plugins']['customconfig']['ckeditor_custom_config'];

    // Check if custom config is populated.
    if (!empty($custom_config)) {

      // Build array from string.
      $config_array = preg_split('/\\R/', $custom_config);

      // Loop through config lines and append to editorSettings.
      foreach ($config_array as $value) {
        $exploded_value = explode(" = ", $value);

        // Convert true/false strings to boolean values.
        if (strcasecmp($exploded_value[1], 'true') == 0 || strcasecmp($exploded_value[1], 'false') == 0) {
          $exploded_value[1] = filter_var($exploded_value[1], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
        }

        // Convert numeric values to integers.
        if (is_numeric($exploded_value[1])) {
          $exploded_value[1] = (int) $exploded_value[1];
        }
        $config['ckeditor_custom_config'][$exploded_value[0]] = $exploded_value[1];
      }
    }
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
    $config = [
      'ckeditor_custom_config' => '',
    ];
    $settings = $editor
      ->getSettings();
    if (isset($settings['plugins']['customconfig'])) {
      $config = $settings['plugins']['customconfig'];
    }

    // Load Editor settings.
    $settings = $editor
      ->getSettings();
    $form['ckeditor_custom_config'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('CKEditor Custom Configuration'),
      '#default_value' => $config['ckeditor_custom_config'],
      '#description' => $this
        ->t('Each line may contain a CKEditor configuration setting formatted as "<code>[setting.name] = [value]</code>". See <a href="@url">https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_config.html</a> for more details.<br>E.g. "<code>forcePasteAsPlainText = true</code>" and "<code>forceSimpleAmpersand = true</code>"', [
        '@url' => 'https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_config.html',
      ]),
      '#attached' => [
        'library' => [
          'ckeditor_config/ckeditor_config.customconfig',
        ],
      ],
      '#element_validate' => [
        [
          $this,
          'validateCustomConfig',
        ],
      ],
    ];
    return $form;
  }

  /**
   * Custom validator for the "custom_config" element in settingsForm().
   */
  public function validateCustomConfig(array $element, FormStateInterface $form_state) {

    // Convert submitted value into an array. Return is empty.
    $config_value = $element['#value'];
    if (empty($config_value)) {
      return;
    }
    $config_array = preg_split('/\\R/', $config_value);

    // Loop through lines.
    $i = 1;
    foreach ($config_array as $value) {

      // Check that syntax matches "[something] = [something]".
      preg_match('/(.*?) \\= (.*)/', $value, $matches);
      if (empty($matches)) {
        $form_state
          ->setError($element, $this
          ->t('The configuration syntax on line @line is incorrect.', [
          '@line' => $i,
        ]));
      }
      $i++;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginBase::getDependencies	public	function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies	1
CKEditorPluginBase::getLibraries	public	function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries	4
CustomConfig::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
CustomConfig::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
CustomConfig::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
CustomConfig::isEnabled	public	function	Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface::isEnabled
CustomConfig::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginBase::isInternal
CustomConfig::settingsForm	public	function	Returns a settings form to configure this CKEditor plugin. Overrides CKEditorPluginConfigurableInterface::settingsForm
CustomConfig::validateCustomConfig	public	function	Custom validator for the "custom_config" element in settingsForm().
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.