class CustomConfig in CKEditor custom config 8

Allow custom config settings.

Plugin annotation

@CKEditorPlugin(
  id = "custom_config",
  label = @Translation("Custom CKEditor config")
)

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\Internal implements CKEditorPluginContextualInterface, ContainerFactoryPluginInterface
        • class \Drupal\ckeditor_config\Plugin\CKEditorPlugin\CustomConfig

File

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

Namespace

Drupal\ckeditor_config\Plugin\CKEditorPlugin

class CustomConfig extends Internal {

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {

    // Get default config.
    $config = parent::getConfig($editor);

    // Parse and implement the custom config.

    /** @var \Drupal\Core\Config\ConfigFactory $configFactory */
    $configFactory = \Drupal::service('config.factory');
    $configForm = $configFactory
      ->get('ckeditor_config.config_form');
    $customConfig = $configForm
      ->get('config');
    if (!empty($customConfig)) {

      // Separate custom config textarea to each row.
      $configArray = explode("\r\n", $customConfig);
      if (is_array($configArray)) {
        foreach ($configArray as $configRow) {
          $configParts = explode('=', $configRow);
          if (count($configParts) == 2) {

            // Prepare value (remove " and ').
            $value = trim($configParts[1]);
            $value = str_replace('"', '', $value);
            $value = str_replace("'", '', $value);

            // Convert boolean values to real boolean.
            if (strtolower($value) == 'true' || $value == 'false') {
              $value = (bool) $value;
            }

            // Append or override the default config.
            $config[trim($configParts[0])] = $value;
          }
        }
      }
    }

    // Return modified config.
    return $config;
  }

}

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::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides Internal::getConfig
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
Internal::$cache	protected	property	The cache backend.
Internal::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Internal::generateACFSettings	protected	function	Builds the ACF part of the CKEditor JS settings.
Internal::generateFormatTagsSetting	protected	function	Builds the "format_tags" configuration part of the CKEditor JS settings.
Internal::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
Internal::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
Internal::isEnabled	public	function	Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface::isEnabled
Internal::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginBase::isInternal
Internal::__construct	public	function	Constructs a \Drupal\ckeditor\Plugin\CKEditorPlugin\Internal object. Overrides PluginBase::__construct
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.
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.