class CkeditorTemplatesUi in Ckeditor templates user interface 8

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_templates\Plugin\CKEditorPlugin\CkeditorTemplates implements CKEditorPluginConfigurableInterface, ContainerFactoryPluginInterface
        • class \Drupal\ckeditor_templates_ui\CkeditorTemplatesUi

File

src/CkeditorTemplatesUi.php, line 9

Namespace

Drupal\ckeditor_templates_ui

class CkeditorTemplatesUi extends CkeditorTemplates {

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    $config = [];
    $settings = $editor
      ->getSettings();

    // Set replace content default value if set.
    if (isset($settings['plugins']['templates']['replace_content'])) {
      $config['templates_replaceContent'] = $settings['plugins']['templates']['replace_content'];
    }
    $config['templates_files'] = $this
      ->getTemplatesDefaultPath();
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
    $form = parent::settingsForm($form, $form_state, $editor);

    // Disable template path option.
    $form['template_path']['#disabled'] = TRUE;
    $form['template_path']['#description'] .= '. ' . t('Note: This option will not work when CKeditor templates UI module is enabled.');
    return $form;
  }

  /**
   * Generate the path to the template file.
   *
   * The file will be picked from :
   * - the module js folder.
   *
   * @return array
   *   List of path to the template file.
   */
  private function getTemplatesDefaultPath() {
    global $base_path;
    return [
      $base_path . drupal_get_path('module', 'ckeditor_templates_ui') . '/js/ckeditor_templates.js',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginBase::getDependencies	public	function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies	1
CKEditorPluginBase::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal	4
CkeditorTemplates::$configFactoryService	private	property	Configuration Factory Service.
CkeditorTemplates::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CkeditorTemplates::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface::getButtons
CkeditorTemplates::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
CkeditorTemplates::getLibraries	public	function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginBase::getLibraries
CkeditorTemplates::getTemplatesPluginPath	private	function	Return ckeditor templates plugin path relative to drupal root.
CkeditorTemplates::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
CkeditorTemplatesUi::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CkeditorTemplates::getConfig
CkeditorTemplatesUi::getTemplatesDefaultPath	private	function	Generate the path to the template file. Overrides CkeditorTemplates::getTemplatesDefaultPath
CkeditorTemplatesUi::settingsForm	public	function	Returns a settings form to configure this CKEditor plugin. Overrides CkeditorTemplates::settingsForm
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.