class LlamaButton in Zircon Profile 8

Defines a "LlamaButton" plugin, with a toolbar builder-enabled "llama" feature.

Plugin annotation

@CKEditorPlugin(
  id = "llama_button",
  label = @Translation("Llama 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\LlamaButton implements CKEditorPluginButtonsInterface

File

core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaButton.php, line 20

Contains \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaButton.

Namespace

Drupal\ckeditor_test\Plugin\CKEditorPlugin

class LlamaButton extends Llama implements CKEditorPluginButtonsInterface {

  /**
   * {@inheritdoc}
   */
  function getButtons() {
    return array(
      'Llama' => array(
        'label' => t('Insert Llama'),
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  function getFile() {
    return drupal_get_path('module', 'ckeditor_test') . '/js/llama_button.js';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Llama::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
Llama::getDependencies		function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies
Llama::getLibraries		function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries
Llama::isInternal		function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal
LlamaButton::getButtons		function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
LlamaButton::getFile		function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides Llama::getFile
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69