Internal
class Internal extends CKEditorPluginBase implements ContainerFactoryPluginInterface, CKEditorPluginContextualInterface (View source)
Defines the "internal" plugin (i.e. core plugins part of our CKEditor build).
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected ModuleExtensionList | $moduleList | The module list service. |
from CKEditorPluginBase |
| protected CacheBackendInterface | $cache | The cache backend. |
Methods
Constructs a \Drupal\ckeditor\Plugin\CKEditorPlugin\Internal object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Gets the Drupal-root relative installation directory of a module.
Indicates if this plugin is part of the optimized CKEditor build.
Creates an instance of the plugin.
Returns the Drupal root-relative file path to the plugin JavaScript file.
Returns the buttons that this plugin provides, along with metadata.
Builds the "format_tags" configuration part of the CKEditor JS settings.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition, CacheBackendInterface $cache_backend)
Constructs a \Drupal\ckeditor\Plugin\CKEditorPlugin\Internal object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
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
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
protected ModuleExtensionList
getModuleList()
Gets the module list service.
protected string
getModulePath(string $module_name)
Gets the Drupal-root relative installation directory of a module.
bool
isInternal()
Indicates if this plugin is part of the optimized CKEditor build.
Plugins marked as internal are implicitly loaded as part of CKEditor.
array
getDependencies(Editor $editor)
Returns a list of plugins this plugin requires.
array
getLibraries(Editor $editor)
Returns a list of libraries this plugin requires.
These libraries will be attached to the text_format element on which the editor is being loaded.
static ContainerFactoryPluginInterface
create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)
Creates an instance of the plugin.
bool
isEnabled(Editor $editor)
Checks if this plugin should be enabled based on the editor configuration.
The editor's settings can be retrieved via $editor->getSettings().
string|false
getFile()
Returns the Drupal root-relative file path to the plugin JavaScript file.
Note: this does not use a Drupal library because this uses CKEditor's API.
array
getConfig(Editor $editor)
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
array
getButtons()
Returns the buttons that this plugin provides, along with metadata.
The metadata is used by the CKEditor module to generate a visual CKEditor toolbar builder UI.
protected string|false
generateFormatTagsSetting(Editor $editor)
Builds the "format_tags" configuration part of the CKEditor JS settings.
protected array
generateACFSettings(Editor $editor)
Builds the ACF part of the CKEditor JS settings.
This ensures that CKEditor obeys the HTML restrictions defined by Drupal's filter system, by enabling CKEditor's Advanced Content Filter (ACF) functionality: http://ckeditor.com/blog/CKEditor-4.1-RC-Released.