class CodeSnippetGeshiCKEditorButton in GeSHi Filter for syntax highlighting 8
Same name and namespace in other branches
- 8.2 codesnippetgeshi/src/Plugin/CKEditorPlugin/CodeSnippetGeshiCKEditorButton.php \Drupal\codesnippetgeshi\Plugin\CKEditorPlugin\CodeSnippetGeshiCKEditorButton
Defines the "codesnippetgeshi" plugin.
Plugin annotation
@CKEditorPlugin(
id = "codesnippetgeshi",
label = @Translation("Add a button to use codesnippetgeshi plugin.")
)
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\codesnippetgeshi\Plugin\CKEditorPlugin\CodeSnippetGeshiCKEditorButton
- class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of CodeSnippetGeshiCKEditorButton
File
- codesnippetgeshi/
src/ Plugin/ CKEditorPlugin/ CodeSnippetGeshiCKEditorButton.php, line 17
Namespace
Drupal\codesnippetgeshi\Plugin\CKEditorPluginView source
class CodeSnippetGeshiCKEditorButton extends CKEditorPluginBase {
/**
* {@inheritdoc}
*/
public function getButtons() {
return [
'CodeSnippet' => [
'label' => t('Add a button to use codesnippetgeshi plugin.'),
'image' => drupal_get_path('module', 'codesnippetgeshi') . '/icons/codesnippet.png',
],
];
}
/**
* {@inheritdoc}
*/
public function getFile() {
return 'libraries/codesnippetgeshi/plugin.js';
}
/**
* {@inheritdoc}
*/
public function isInternal() {
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getDependencies(Editor $editor) {
return [
'xml',
'ajax',
'codesnippet',
];
}
/**
* {@inheritdoc}
*/
public function getLibraries(Editor $editor) {
return [];
}
/**
* {@inheritdoc}
*/
public function getConfig(Editor $editor) {
$languages = GeshiFilter::getEnabledLanguages();
// Before sending along to CKEditor, alpha sort and capitalize the language.
$languages = array_map(function ($language) {
return ucwords($language);
}, $languages);
asort($languages);
return [
'codeSnippet_languages' => $languages,
];
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CodeSnippetGeshiCKEditorButton:: |
public | function |
Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface:: |
|
CodeSnippetGeshiCKEditorButton:: |
public | function |
Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface:: |
|
CodeSnippetGeshiCKEditorButton:: |
public | function |
Returns a list of plugins this plugin requires. Overrides CKEditorPluginBase:: |
|
CodeSnippetGeshiCKEditorButton:: |
public | function |
Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface:: |
|
CodeSnippetGeshiCKEditorButton:: |
public | function |
Returns a list of libraries this plugin requires. Overrides CKEditorPluginBase:: |
|
CodeSnippetGeshiCKEditorButton:: |
public | function |
Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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:: |
3 |
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. | 92 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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. |