class InsertView in Advanced Insert View 2.0.x
Same name in this branch
- 2.0.x src/Plugin/Filter/InsertView.php \Drupal\insert_view_adv\Plugin\Filter\InsertView
- 2.0.x src/Plugin/CKEditorPlugin/InsertView.php \Drupal\insert_view_adv\Plugin\CKEditorPlugin\InsertView
Same name and namespace in other branches
- 8 src/Plugin/CKEditorPlugin/InsertView.php \Drupal\insert_view_adv\Plugin\CKEditorPlugin\InsertView
The plugin for insert_view_adv .
Plugin annotation
@CKEditorPlugin(
id = "insert_view_adv",
label = @Translation("Advanced Insert View WYSIWYG")
)
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\insert_view_adv\Plugin\CKEditorPlugin\InsertView implements CKEditorPluginConfigurableInterface, ContainerFactoryPluginInterface
- class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of InsertView
File
- src/
Plugin/ CKEditorPlugin/ InsertView.php, line 22
Namespace
Drupal\insert_view_adv\Plugin\CKEditorPluginView source
class InsertView extends CKEditorPluginBase implements CKEditorPluginConfigurableInterface, ContainerFactoryPluginInterface {
/**
* The module extension list.
*
* @var \Drupal\Core\Extension\ModuleExtensionList
*/
protected $moduleExtensionList;
/**
* Constructs a new DrupalMediaLibrary plugin object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param array $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
* The module extension list.
*/
public function __construct(array $configuration, $plugin_id, array $plugin_definition, ModuleExtensionList $extension_list_module) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->moduleExtensionList = $extension_list_module;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('extension.list.module'));
}
/**
* {@inheritdoc}
*/
public function getFile() {
return $this->moduleExtensionList
->getPath('insert_view_adv') . '/js/plugin/plugin.js';
}
/**
* {@inheritdoc}
*/
public function getButtons() {
return [
'insert_view_adv' => [
'label' => $this
->t('Advanced insert View'),
'image' => $this->moduleExtensionList
->getPath('insert_view_adv') . '/js/plugin/icons/insert_view_adv.png',
],
];
}
/**
* {@inheritdoc}
*/
public function getConfig(Editor $editor) {
$settings = $editor
->getSettings();
if (isset($settings['plugins']['insert_view_adv'])) {
$plugin_specific_settings = $settings['plugins']['insert_view_adv'];
}
else {
$plugin_specific_settings = [
'enable_live_preview' => TRUE,
];
}
$plugin_specific_settings['InsertViewDialog_url'] = Url::fromRoute('insert_view_adv.editor_dialog', [
'filter_format' => $editor
->getFilterFormat()
->id(),
])
->toString(TRUE)
->getGeneratedUrl();
$plugin_specific_settings['InsertViewDialog_options'] = [
'dialogClass' => 'insert-view-dialog',
'title' => $this
->t('Advanced Insert View'),
];
$plugin_specific_settings['InsertViewPreview_url'] = Url::fromRoute('insert_view_adv.editor_preview', [
'filter_format' => $editor
->getFilterFormat()
->id(),
])
->toString(TRUE)
->getGeneratedUrl();
return $plugin_specific_settings;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
$settings = $editor
->getSettings();
if (!empty($settings['plugins']['insert_view_adv'])) {
$plugin_specific_settings = $settings['plugins']['insert_view_adv'];
}
else {
$plugin_specific_settings = [
'enable_live_preview' => TRUE,
];
}
$form['enable_live_preview'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable live preview of the view token'),
'#description' => $this
->t('By default CKEditor displays only token with view details, if you want to see the exact results of the view leave this checkbox checked'),
'#default_value' => isset($plugin_specific_settings['enable_live_preview']) ? $plugin_specific_settings['enable_live_preview'] : TRUE,
'#return_value' => TRUE,
];
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CKEditorPluginBase:: |
protected | property | The module list service. | |
CKEditorPluginBase:: |
public | function |
Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface:: |
1 |
CKEditorPluginBase:: |
public | function |
Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface:: |
4 |
CKEditorPluginBase:: |
protected | function | Gets the module list service. | |
CKEditorPluginBase:: |
protected | function | Gets the Drupal-root relative installation directory of a module. | |
CKEditorPluginBase:: |
public | function |
Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface:: |
4 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
InsertView:: |
protected | property | The module extension list. | |
InsertView:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
InsertView:: |
public | function |
Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface:: |
|
InsertView:: |
public | function |
Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface:: |
|
InsertView:: |
public | function |
Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface:: |
|
InsertView:: |
public | function |
Returns a settings form to configure this CKEditor plugin. Overrides CKEditorPluginConfigurableInterface:: |
|
InsertView:: |
public | function |
Constructs a new DrupalMediaLibrary plugin object. Overrides PluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |