1. class
  2. Drupal
  3. \
  4. ckeditor5
  5. \
  6. SmartDefaultSettings

SmartDefaultSettings

final class SmartDefaultSettings (View source)

internal  This class may change at any time. It is not for use outside this module.
 

Generates CKEditor 5 settings for existing text editors/formats.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected CKEditor5PluginManagerInterface $pluginManager

The CKEditor 5 plugin manager.
protected PluginManagerInterface $upgradePluginManager

The CKEditor 4 to 5 upgrade plugin manager.
protected CKEditorPluginManager $cke4PluginManager

The "CKEditor 4 plugin" plugin manager.

Methods

TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(CKEditor5PluginManagerInterface $plugin_manager, PluginManagerInterface $upgrade_plugin_manager, CKEditorPluginManager $cke4_plugin_manager = NULL)

Constructs a SmartDefaultSettings object.

array
computeSmartDefaultSettings(EditorInterface|null $text_editor, FilterFormatInterface $text_format)

Computes the closest possible equivalent settings for switching to CKEditor 5.

array
getEnabledCkeditor4Plugins(EditorInterface $editor)

Gets all enabled CKEditor 4 plugins.

Details

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 60
__construct(CKEditor5PluginManagerInterface $plugin_manager, PluginManagerInterface $upgrade_plugin_manager, CKEditorPluginManager $cke4_plugin_manager = NULL)

Constructs a SmartDefaultSettings object.

Parameters

CKEditor5PluginManagerInterface $plugin_manager

The CKEditor 5 plugin manager.
PluginManagerInterface $upgrade_plugin_manager

The CKEditor 4 to 5 upgrade plugin manager.
CKEditorPluginManager $cke4_plugin_manager

The CKEditor 4 plugin manager.

at line 85
array computeSmartDefaultSettings(EditorInterface|null $text_editor, FilterFormatInterface $text_format)

Computes the closest possible equivalent settings for switching to CKEditor 5.

Parameters

EditorInterface|null $text_editor

The editor being reconfigured for CKEditor 5 to match the CKEditor 4 settings as closely as possible (if it was using CKEditor 4).
FilterFormatInterface $text_format

The text format for which to compute smart default settings.

Return Value

array

An array with two values:

  1. The cloned config entity with settings modified for CKEditor 5 … or a completely new config entity if this text format did not yet have one.
  2. Messages explaining what conclusions were reached.

Exceptions

InvalidArgumentException

at line 290
protected array getEnabledCkeditor4Plugins(EditorInterface $editor)

Gets all enabled CKEditor 4 plugins.

Parameters

EditorInterface $editor

A text editor config entity configured to use CKEditor 4.

Return Value

array

The enabled CKEditor 4 plugin IDs.