class CookieContentBlocker in Cookie Content Blocker 8

Defines the DraftText CKEditor plugin.

@package Drupal\cookie_content_blocker\PLugin\CKEditorPlugin

Plugin annotation

@CKEditorPlugin(
  id = "cookiecontentblocker",
  label = @Translation("Cookie Content Blocker"),
  module = "cookie_content_blocker"
)

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\cookie_content_blocker\Plugin\CKEditorPlugin\CookieContentBlocker implements CKEditorPluginCssInterface

File

src/Plugin/CKEditorPlugin/CookieContentBlocker.php, line 20

Namespace

Drupal\cookie_content_blocker\Plugin\CKEditorPlugin

class CookieContentBlocker extends CKEditorPluginBase implements CKEditorPluginCssInterface {

  /**
   * The path of this module.
   *
   * @var string
   */
  protected $modulePath;

  /**
   * Constructs the Cookie Conten Blocked CKEditor Plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->modulePath = drupal_get_path('module', 'cookie_content_blocker');
  }

  /**
   * {@inheritdoc}
   */
  public function getCssFiles(Editor $editor) : array {
    return [
      $this->modulePath . '/js/plugins/cookiecontentblocker/css/editor.css',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFile() : string {
    return $this->modulePath . '/js/plugins/cookiecontentblocker/plugin.js';
  }

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

  /**
   * {@inheritdoc}
   */
  public function getButtons() : array {
    return [
      'CookieContentBlocker' => [
        'label' => $this
          ->t('Add Cookie Content Blocker content'),
        'image' => $this->modulePath . '/js/plugins/cookiecontentblocker/icons/cookiecontentblocker.png',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginBase::getDependencies	public	function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies	1
CKEditorPluginBase::getLibraries	public	function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries	4
CKEditorPluginBase::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal	4
CookieContentBlocker::$modulePath	protected	property	The path of this module.
CookieContentBlocker::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
CookieContentBlocker::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
CookieContentBlocker::getCssFiles	public	function	Retrieves enabled plugins' iframe instance CSS files. Overrides CKEditorPluginCssInterface::getCssFiles
CookieContentBlocker::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
CookieContentBlocker::__construct	public	function	Constructs the Cookie Conten Blocked CKEditor Plugin. Overrides PluginBase::__construct
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.
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.