class Templates in Wysiwyg API template plugin 3.0.x
Same name and namespace in other branches
- 8.2 src/Plugin/CKEditorPlugin/Templates.php \Drupal\wysiwyg_template\Plugin\CKEditorPlugin\Templates
Defines the CKEditor Templates plugin.
No buttons are exposed for this plugin, it is only here so it gets properly loaded by the Drupal-specific TemplateSelector plugin.
Plugin annotation
@CKEditorPlugin(
id = "templates",
label = @Translation("Template selector"),
module = "wysiwyg_template"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\wysiwyg_template\Plugin\CKEditorPlugin\Templates implements CKEditorPluginInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Templates
File
- src/
Plugin/ CKEditorPlugin/ Templates.php, line 25
Namespace
Drupal\wysiwyg_template\Plugin\CKEditorPluginView source
class Templates extends PluginBase implements CKEditorPluginInterface, ContainerFactoryPluginInterface {
/**
* The wysiwyg_template.settings config object.
*
* @var \Drupal\Core\Config\ImmutableConfig
*/
protected $config;
/**
* The current request stack.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected $requestStack;
/**
* Constructs the CKEditor Templates plugin.
*
* @param array $configuration
* The plugin configuration.
* @param string $plugin_id
* The plugin ID.
* @param mixed $plugin_definition
* The plugin definition.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory service.
* @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
* The current request stack.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, RequestStack $request_stack) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->config = $config_factory
->get('wysiwyg_template.settings');
$this->requestStack = $request_stack;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('config.factory'), $container
->get('request_stack'));
}
/**
* {@inheritdoc}
*/
public function isInternal() : bool {
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getDependencies(Editor $editor) : array {
return [];
}
/**
* {@inheritdoc}
*/
public function getLibraries(Editor $editor) : array {
return [];
}
/**
* {@inheritdoc}
*/
public function getFile() : string {
return $this->config
->get('library_path') . '/plugin.js';
}
/**
* {@inheritdoc}
*/
public function getConfig(Editor $editor) : array {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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. | |
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. | |
Templates:: |
protected | property | The wysiwyg_template.settings config object. | |
Templates:: |
protected | property | The current request stack. | |
Templates:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
Templates:: |
public | function |
Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface:: |
|
Templates:: |
public | function |
Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface:: |
|
Templates:: |
public | function |
Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface:: |
|
Templates:: |
public | function |
Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface:: |
|
Templates:: |
public | function |
Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface:: |
|
Templates:: |
public | function |
Constructs the CKEditor Templates plugin. Overrides PluginBase:: |