class LlamaContextualAndButton in Zircon Profile 8
Same name and namespace in other branches
- 8.0 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\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\ckeditor_test\Plugin\CKEditorPlugin\Llama implements CKEditorPluginInterface
- class \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton implements CKEditorPluginButtonsInterface, CKEditorPluginConfigurableInterface, CKEditorPluginContextualInterface
- class \Drupal\ckeditor_test\Plugin\CKEditorPlugin\Llama implements CKEditorPluginInterface
Expanded class hierarchy of LlamaContextualAndButton
File
- core/
modules/ ckeditor/ tests/ modules/ src/ Plugin/ CKEditorPlugin/ LlamaContextualAndButton.php, line 25 - Contains \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton.
Namespace
Drupal\ckeditor_test\Plugin\CKEditorPluginView source
class LlamaContextualAndButton extends Llama implements CKEditorPluginContextualInterface, CKEditorPluginButtonsInterface, CKEditorPluginConfigurableInterface {
/**
* {@inheritdoc}
*/
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}
*/
function getButtons() {
return array(
'Llama' => array(
'label' => t('Insert Llama'),
),
);
}
/**
* {@inheritdoc}
*/
function getFile() {
return drupal_get_path('module', 'ckeditor_test') . '/js/llama_contextual_and_button.js';
}
/**
* {@inheritdoc}
*/
function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
// Defaults.
$config = array(
'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'] = array(
'#title' => t('Ultra llama mode'),
'#type' => 'checkbox',
'#default_value' => $config['ultra_llama_mode'],
);
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Llama:: |
public | function |
Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface:: |
|
Llama:: |
function |
Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface:: |
||
Llama:: |
function |
Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface:: |
||
Llama:: |
function |
Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface:: |
||
LlamaContextualAndButton:: |
function |
Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface:: |
||
LlamaContextualAndButton:: |
function |
Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides Llama:: |
||
LlamaContextualAndButton:: |
function |
Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface:: |
||
LlamaContextualAndButton:: |
function |
Returns a settings form to configure this CKEditor plugin. Overrides CKEditorPluginConfigurableInterface:: |
||
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
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:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Constructs a Drupal\Component\Plugin\PluginBase object. | 69 |