class LlamaContextualAndButton in Drupal 10
Same name and namespace in other branches
- 8 core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton
- 9 core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton
Defines a "LlamaContextualAndButton" plugin, with a contextually OR toolbar builder-enabled "llama" feature.
Plugin annotation
@CKEditorPlugin(
id = "llama_contextual_and_button",
label = @Translation("Contextual Llama With Button")
)
Hierarchy
- class \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton extends \Drupal\ckeditor_test\Plugin\CKEditorPlugin\Llama implements CKEditorPluginButtonsInterface, CKEditorPluginConfigurableInterface, CKEditorPluginContextualInterface
Expanded class hierarchy of LlamaContextualAndButton
File
- core/
modules/ ckeditor/ tests/ modules/ src/ Plugin/ CKEditorPlugin/ LlamaContextualAndButton.php, line 20
Namespace
Drupal\ckeditor_test\Plugin\CKEditorPluginView source
class LlamaContextualAndButton extends Llama implements CKEditorPluginContextualInterface, CKEditorPluginButtonsInterface, CKEditorPluginConfigurableInterface {
/**
* {@inheritdoc}
*/
public function isEnabled(Editor $editor) {
// Automatically enable this plugin if the Strike button is enabled.
$settings = $editor
->getSettings();
foreach ($settings['toolbar']['rows'] as $row) {
foreach ($row as $group) {
if (in_array('Strike', $group['items'])) {
return TRUE;
}
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getButtons() {
return [
'Llama' => [
'label' => t('Insert Llama'),
],
];
}
/**
* {@inheritdoc}
*/
public function getFile() {
return $this->moduleList
->getPath('ckeditor_test') . '/js/llama_contextual_and_button.js';
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
// Defaults.
$config = [
'ultra_llama_mode' => FALSE,
];
$settings = $editor
->getSettings();
if (isset($settings['plugins']['llama_contextual_and_button'])) {
$config = $settings['plugins']['llama_contextual_and_button'];
}
$form['ultra_llama_mode'] = [
'#title' => t('Ultra llama mode'),
'#type' => 'checkbox',
'#default_value' => $config['ultra_llama_mode'],
];
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CKEditorPluginInterface:: |
public | function | Returns the additions to CKEDITOR.config for a specific CKEditor instance. | |
CKEditorPluginInterface:: |
public | function | Returns a list of plugins this plugin requires. | |
CKEditorPluginInterface:: |
public | function | Returns a list of libraries this plugin requires. | |
CKEditorPluginInterface:: |
public | function | Indicates if this plugin is part of the optimized CKEditor build. | |
LlamaContextualAndButton:: |
public | function |
Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface:: |
|
LlamaContextualAndButton:: |
public | function |
Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface:: |
|
LlamaContextualAndButton:: |
public | function |
Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface:: |
|
LlamaContextualAndButton:: |
public | function |
Returns a settings form to configure this CKEditor plugin. Overrides CKEditorPluginConfigurableInterface:: |
|
PluginInspectionInterface:: |
public | function | Gets the definition of the plugin implementation. | 1 |
PluginInspectionInterface:: |
public | function | Gets the plugin_id of the plugin instance. | 1 |