class BidiCKEditorButton in CKEditor BiDi Buttons 8

Defines the "bidi" plugin.

NOTE: The plugin ID ('id' key) corresponds to the CKEditor plugin name. It is the first argument of the CKEDITOR.plugins.add() function in the plugin.js file.

Plugin annotation

@CKEditorPlugin(
  id = "bidi",
  label = @Translation("Bidi CKEditor Buttons")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface
      • class \Drupal\ckeditor_bidi\Plugin\CKEditorPlugin\BidiCKEditorButton

File

src/Plugin/CKEditorPlugin/BidiCKEditorButton.php, line 25

Contains \Drupal\ckeditor_bidi\Plugin\CKEditorPlugin\BidiCKEditorButton.

Namespace

Drupal\ckeditor_bidi\Plugin\CKEditorPlugin

class BidiCKEditorButton extends CKEditorPluginBase {

  /**
   * {@inheritdoc}
   *
   * NOTE: The keys of the returned array corresponds to the CKEditor button
   * names. They are the first argument of the editor.ui.addButton() or
   * editor.ui.addRichCombo() functions in the plugin.js file.
   */
  public function getButtons() {

    // Make sure that the path to the image matches the file structure of
    // the CKEditor plugin you are implementing.
    $path = 'libraries/bidi';

    // Support for "Libaraies API" module.
    if (\Drupal::moduleHandler()
      ->moduleExists('libraries')) {
      $path = libraries_get_path('bidi');
    }
    return array(
      'BidiLtr' => array(
        'label' => $this
          ->t('Text direction from left to right'),
        'image' => $path . '/icons/bidiltr.png',
      ),
      'BidiRtl' => array(
        'label' => $this
          ->t('Text direction from right to left'),
        'image' => $path . '/icons/bidirtl.png',
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getFile() {
    $file_path = 'libraries/bidi/plugin.js';

    // Support for "Libaraies API" module.
    if (\Drupal::moduleHandler()
      ->moduleExists('libraries')) {
      $file_path = libraries_get_path('bidi') . '/plugin.js';
    }
    return $file_path;
  }

  /**
   * {@inheritdoc}
   */
  function isInternal() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  function getDependencies(Editor $editor) {
    return array();
  }

  /**
   * {@inheritdoc}
   */
  function getLibraries(Editor $editor) {
    return array();
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    return array();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BidiCKEditorButton::getButtons	public	function	NOTE: The keys of the returned array corresponds to the CKEditor button names. They are the first argument of the editor.ui.addButton() or editor.ui.addRichCombo() functions in the plugin.js file. Overrides CKEditorPluginButtonsInterface::getButtons
BidiCKEditorButton::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
BidiCKEditorButton::getDependencies		function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginBase::getDependencies
BidiCKEditorButton::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
BidiCKEditorButton::getLibraries		function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginBase::getLibraries
BidiCKEditorButton::isInternal		function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginBase::isInternal
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
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	3
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.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.