class LlamaButton

Same name and namespace in other branches
  1. 8.9.x core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaButton.php \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaButton

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

Plugin annotation


@CKEditorPlugin(
  id = "llama_button",
  label = @Translation("Llama Button")
)

Hierarchy

Expanded class hierarchy of LlamaButton

File

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

Namespace

Drupal\ckeditor_test\Plugin\CKEditorPlugin
View source
class LlamaButton extends Llama implements CKEditorPluginButtonsInterface {
    
    /**
     * {@inheritdoc}
     */
    public function getButtons() {
        return [
            'Llama' => [
                'label' => $this->t('Insert Llama'),
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFile() {
        return $this->moduleList
            ->getPath('ckeditor_test') . '/js/llama_button.js';
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Llama::$moduleList protected property The module list service.
Llama::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Llama::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
Llama::getDependencies public function Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies
Llama::getLibraries public function Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries
Llama::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal
LlamaButton::getButtons public function Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
LlamaButton::getFile public 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.
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::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 8
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.