class Boxout in Boxout 8

Defines the "Boxout" plugin.

Plugin annotation

@CKEditorPlugin(
  id = "boxout",
  label = @Translation("Boxout"),
  module = "boxout"
)

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\boxout\Plugin\CKEditorPlugin\Boxout

6 string references to 'Boxout'

boxout.info.yml in ./boxout.info.yml

boxout.info.yml

boxout.routing.yml in ./boxout.routing.yml

boxout.routing.yml

Boxout::getButtons in src/Plugin/CKEditorPlugin/Boxout.php

Implements CKEditorPluginButtonsInterface::getButtons().

BoxoutTest::setUp in tests/src/Functional/BoxoutTest.php

BoxoutTest::testBoxoutArticle in tests/src/Functional/BoxoutTest.php

Test article creation.

... See full list

File

src/Plugin/CKEditorPlugin/Boxout.php, line 17

Namespace

Drupal\boxout\Plugin\CKEditorPlugin

class Boxout extends CKEditorPluginBase {

  /**
   * Gets a path to module.
   *
   * @return string
   *   Full path to module.
   */
  private function path() {
    return drupal_get_path('module', 'boxout');
  }

  /**
   * Implements CKEditorPluginInterface::getDependencies().
   */
  public function getDependencies(Editor $editor) {
    return array();
  }

  /**
   * Implements CKEditorPluginInterface::getLibraries().
   */
  public function getLibraries(Editor $editor) {
    return array();
  }

  /**
   * Implements CKEditorPluginInterface::isInternal().
   */
  public function isInternal() {
    return FALSE;
  }

  /**
   * Implements CKEditorPluginInterface::getFile().
   */
  public function getFile() {
    return $this
      ->path() . "/js/plugins/boxout/plugin.js";
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    return array(
      'boxout_dialog_title_insert' => $this
        ->t('Insert Boxout'),
    );
  }

  /**
   * Implements CKEditorPluginButtonsInterface::getButtons().
   */
  public function getButtons() {
    return array(
      'Boxout' => array(
        'label' => $this
          ->t('Boxout'),
        'image' => $this
          ->path() . '/js/plugins/boxout/boxout.png',
      ),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Boxout::getButtons	public	function	Implements CKEditorPluginButtonsInterface::getButtons(). Overrides CKEditorPluginButtonsInterface::getButtons
Boxout::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
Boxout::getDependencies	public	function	Implements CKEditorPluginInterface::getDependencies(). Overrides CKEditorPluginBase::getDependencies
Boxout::getFile	public	function	Implements CKEditorPluginInterface::getFile(). Overrides CKEditorPluginInterface::getFile
Boxout::getLibraries	public	function	Implements CKEditorPluginInterface::getLibraries(). Overrides CKEditorPluginBase::getLibraries
Boxout::isInternal	public	function	Implements CKEditorPluginInterface::isInternal(). Overrides CKEditorPluginBase::isInternal
Boxout::path	private	function	Gets a path to module.
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.