class TemplateSelector in Wysiwyg API template plugin 3.0.x

Defines a WYSIWYG TemplateSelector selector plugin.

Plugin annotation

@CKEditorPlugin(
  id = "templateselector",
  label = @Translation("Template selector"),
  module = "wysiwyg_template"
)

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\wysiwyg_template\Plugin\CKEditorPlugin\TemplateSelector

File

src/Plugin/CKEditorPlugin/TemplateSelector.php, line 18

Namespace

Drupal\wysiwyg_template\Plugin\CKEditorPlugin

class TemplateSelector extends CKEditorPluginBase {

  /**
   * {@inheritdoc}
   */
  public function getButtons() : array {
    return [
      'TemplateSelector' => [
        'label' => $this
          ->t('Insert templates'),
        'image' => drupal_get_path('module', 'wysiwyg_template') . '/js/plugins/templateselector/icons/templateselector.png',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFile() {
    return drupal_get_path('module', 'wysiwyg_template') . '/js/plugins/templateselector/plugin.js';
  }

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

    // Using 'dummy' as entity type and bundle as the config will be overwritten
    // with specific values in @see wysiwyg_template_editor_js_settings_alter().
    return [
      'templates_files' => [
        Url::fromRoute('wysiwyg_template.list_js.type', [
          'entity_type' => 'dummy',
          'bundle' => 'dummy',
        ])
          ->toString(),
      ],
      'templates_replaceContent' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(Editor $editor) : array {
    return [
      'core/drupal.ajax',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getDependencies(Editor $editor) : array {
    return [
      'templates',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginBase::$moduleList	protected	property	The module list service.
CKEditorPluginBase::getModuleList	protected	function	Gets the module list service.
CKEditorPluginBase::getModulePath	protected	function	Gets the Drupal-root relative installation directory of a module.
CKEditorPluginBase::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal	4
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	98
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
TemplateSelector::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
TemplateSelector::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
TemplateSelector::getDependencies	public	function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginBase::getDependencies
TemplateSelector::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
TemplateSelector::getLibraries	public	function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginBase::getLibraries