class UnicornEditor
Same name and namespace in other branches
- 9 core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php \Drupal\editor_test\Plugin\Editor\UnicornEditor
- 8.9.x core/modules/editor/tests/modules/src/Plugin/Editor/UnicornEditor.php \Drupal\editor_test\Plugin\Editor\UnicornEditor
- 10 core/modules/editor/tests/modules/editor_test/src/Plugin/Editor/UnicornEditor.php \Drupal\editor_test\Plugin\Editor\UnicornEditor
Defines a Unicorn-powered text editor for Drupal (for testing purposes).
Attributes
#[Editor(id: 'unicorn', label: new TranslatableMarkup('Unicorn Editor'), supports_content_filtering: TRUE, supports_inline_editing: TRUE, is_xss_safe: FALSE, supported_element_types: [
'textarea',
'textfield',
])]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\editor\Plugin\EditorBase extends \Drupal\editor\Plugin\EditorPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\editor_test\Plugin\Editor\UnicornEditor implements \Drupal\editor\Plugin\EditorBase
- class \Drupal\editor\Plugin\EditorBase extends \Drupal\editor\Plugin\EditorPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of UnicornEditor
File
-
core/
modules/ editor/ tests/ modules/ editor_test/ src/ Plugin/ Editor/ UnicornEditor.php, line 16
Namespace
Drupal\editor_test\Plugin\EditorView source
class UnicornEditor extends EditorBase {
/**
* {@inheritdoc}
*/
public function getDefaultSettings() {
return [
'ponies_too' => TRUE,
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['ponies_too'] = [
'#title' => $this->t('Pony mode'),
'#type' => 'checkbox',
'#default_value' => TRUE,
];
$form_state->loadInclude('editor', 'admin.inc');
$form['image_upload'] = editor_image_upload_settings_form($form_state->get('editor'));
$form['image_upload']['#element_validate'][] = [
$this,
'validateImageUploadSettings',
];
return $form;
}
/**
* Render API callback: Image upload handler for confirmation form.
*
* This function is assigned as a #element_validate callback.
*
* Moves the text editor's image upload settings into $editor->image_upload.
*
* @see editor_image_upload_settings_form()
*/
public function validateImageUploadSettings(array $element, FormStateInterface $form_state) {
$settings =& $form_state->getValue([
'editor',
'settings',
'image_upload',
]);
$form_state->get('editor')
->setImageUploadSettings($settings);
$form_state->unsetValue([
'editor',
'settings',
'image_upload',
]);
}
/**
* {@inheritdoc}
*/
public function getJSSettings(EditorEntity $editor) {
$js_settings = [];
$settings = $editor->getSettings();
if ($settings['ponies_too']) {
$js_settings['ponyModeEnabled'] = TRUE;
}
return $js_settings;
}
/**
* {@inheritdoc}
*/
public function getLibraries(EditorEntity $editor) {
return [
'editor_test/unicorn',
];
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
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 | 3 | |||
DependencySerializationTrait::__wakeup | public | function | 3 | |||
EditorBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | 1 | |
EditorBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | 1 | |
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
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 | Deprecated | public | function | Determines if the plugin is configurable. | ||
PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 82 | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
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. | 1 | ||
UnicornEditor::buildConfigurationForm | public | function | Form constructor. | Overrides EditorBase::buildConfigurationForm | ||
UnicornEditor::getDefaultSettings | public | function | Returns the default settings for this configurable text editor. | Overrides EditorBase::getDefaultSettings | ||
UnicornEditor::getJSSettings | public | function | Returns JavaScript settings to be attached. | Overrides EditorPluginInterface::getJSSettings | ||
UnicornEditor::getLibraries | public | function | Returns libraries to be attached. | Overrides EditorPluginInterface::getLibraries | ||
UnicornEditor::validateImageUploadSettings | public | function | Render API callback: Image upload handler for confirmation form. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.