class LlamaContextual in Drupal 10

Defines a "Llama" plugin, with a contextually enabled "llama" feature.

Plugin annotation

@CKEditorPlugin(
  id = "llama_contextual",
  label = @Translation("Contextual Llama")
)

Hierarchy

• class \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextual extends \Drupal\ckeditor_test\Plugin\CKEditorPlugin\Llama implements CKEditorPluginContextualInterface

File

core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextual.php, line 16

Namespace

Drupal\ckeditor_test\Plugin\CKEditorPlugin

class LlamaContextual extends Llama implements CKEditorPluginContextualInterface {

  /**
   * {@inheritdoc}
   */
  public function isEnabled(Editor $editor) {

    // Automatically enable this plugin if the Underline 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 getFile() {
    return $this->moduleList
      ->getPath('ckeditor_test') . '/js/llama_contextual.js';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginInterface::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance.
CKEditorPluginInterface::getDependencies	public	function	Returns a list of plugins this plugin requires.
CKEditorPluginInterface::getLibraries	public	function	Returns a list of libraries this plugin requires.
CKEditorPluginInterface::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build.
LlamaContextual::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
LlamaContextual::isEnabled	public	function	Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface::isEnabled
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	1
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	1