abstract class CKEditorPluginBase in Drupal 9
Same name and namespace in other branches
- 8 core/modules/ckeditor/src/CKEditorPluginBase.php \Drupal\ckeditor\CKEditorPluginBase
Defines a base CKEditor plugin implementation.
No other CKEditor plugins can be internal, unless a different CKEditor build than the one provided by Drupal core is used. Most CKEditor plugins don't need to provide additional settings forms.
This base class assumes that your plugin has buttons that you want to be enabled through the toolbar builder UI. It is still possible to also implement the CKEditorPluginContextualInterface (for contextual enabling) and CKEditorPluginConfigurableInterface interfaces (for configuring plugin settings).
NOTE: the Drupal plugin ID should correspond to the CKEditor plugin name.
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\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of CKEditorPluginBase
See also
\Drupal\ckeditor\CKEditorPluginInterface
\Drupal\ckeditor\CKEditorPluginButtonsInterface
\Drupal\ckeditor\CKEditorPluginContextualInterface
\Drupal\ckeditor\CKEditorPluginConfigurableInterface
\Drupal\ckeditor\CKEditorPluginManager
\Drupal\ckeditor\Annotation\CKEditorPlugin
6 files declare their use of CKEditorPluginBase
- DrupalImage.php in core/
modules/ ckeditor/ src/ Plugin/ CKEditorPlugin/ DrupalImage.php - DrupalLink.php in core/
modules/ ckeditor/ src/ Plugin/ CKEditorPlugin/ DrupalLink.php - DrupalMediaLibrary.php in core/
modules/ media_library/ src/ Plugin/ CKEditorPlugin/ DrupalMediaLibrary.php - Internal.php in core/
modules/ ckeditor/ src/ Plugin/ CKEditorPlugin/ Internal.php - Language.php in core/
modules/ ckeditor/ src/ Plugin/ CKEditorPlugin/ Language.php
File
- core/
modules/ ckeditor/ src/ CKEditorPluginBase.php, line 32
Namespace
Drupal\ckeditorView source
abstract class CKEditorPluginBase extends PluginBase implements CKEditorPluginInterface, CKEditorPluginButtonsInterface {
/**
* The module list service.
*
* @var \Drupal\Core\Extension\ModuleExtensionList
*/
protected $moduleList;
/**
* Gets the module list service.
*
* @return \Drupal\Core\Extension\ModuleExtensionList
* The module extension list service.
*/
protected function getModuleList() : ModuleExtensionList {
if (!$this->moduleList) {
$this->moduleList = \Drupal::service('extension.list.module');
}
return $this->moduleList;
}
/**
* Gets the Drupal-root relative installation directory of a module.
*
* @param string $module_name
* The machine name of the module.
*
* @return string
* The module installation directory.
*
* @throws \InvalidArgumentException
* If there is no extension with the supplied machine name.
*
* @see \Drupal\Core\Extension\ExtensionList::getPath()
*/
protected function getModulePath(string $module_name) : string {
return $this
->getModuleList()
->getPath($module_name);
}
/**
* {@inheritdoc}
*/
public function isInternal() {
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getDependencies(Editor $editor) {
return [];
}
/**
* {@inheritdoc}
*/
public function getLibraries(Editor $editor) {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CKEditorPluginBase:: |
protected | property | The module list service. | |
CKEditorPluginBase:: |
public | function |
Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface:: |
1 |
CKEditorPluginBase:: |
public | function |
Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface:: |
4 |
CKEditorPluginBase:: |
protected | function | Gets the module list service. | |
CKEditorPluginBase:: |
protected | function | Gets the Drupal-root relative installation directory of a module. | |
CKEditorPluginBase:: |
public | function |
Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface:: |
4 |
CKEditorPluginButtonsInterface:: |
public | function | Returns the buttons that this plugin provides, along with metadata. | 9 |
CKEditorPluginInterface:: |
public | function | Returns the additions to CKEDITOR.config for a specific CKEditor instance. | 7 |
CKEditorPluginInterface:: |
public | function | Returns the Drupal root-relative file path to the plugin JavaScript file. | 11 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |