class Editor in Zircon Profile 8
Same name in this branch
- 8 core/modules/editor/src/Annotation/Editor.php \Drupal\editor\Annotation\Editor
- 8 core/modules/editor/src/Entity/Editor.php \Drupal\editor\Entity\Editor
- 8 core/modules/editor/src/Plugin/InPlaceEditor/Editor.php \Drupal\editor\Plugin\InPlaceEditor\Editor
Same name and namespace in other branches
- 8.0 core/modules/editor/src/Entity/Editor.php \Drupal\editor\Entity\Editor
Defines the configured text editor entity.
Plugin annotation
@ConfigEntityType(
id = "editor",
label = @Translation("Text Editor"),
entity_keys = {
"id" = "format"
},
config_export = {
"format",
"editor",
"settings",
"image_upload",
}
)
Hierarchy
- class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
- class \Drupal\editor\Entity\Editor implements EditorInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
Expanded class hierarchy of Editor
30 files declare their use of Editor
- ckeditor.api.php in core/
modules/ ckeditor/ ckeditor.api.php - Documentation for CKEditor module APIs.
- ckeditor.module in core/
modules/ ckeditor/ ckeditor.module - Provides integration with the CKEditor WYSIWYG editor.
- CKEditor.php in core/
modules/ ckeditor/ src/ Plugin/ Editor/ CKEditor.php - Contains \Drupal\ckeditor\Plugin\Editor\CKEditor.
- CKEditorAdminTest.php in core/
modules/ ckeditor/ src/ Tests/ CKEditorAdminTest.php - Contains \Drupal\ckeditor\Tests\CKEditorAdminTest.
- CKEditorPluginBase.php in core/
modules/ ckeditor/ src/ CKEditorPluginBase.php - Contains \Drupal\ckeditor\CKEditorPluginBase.
File
- core/
modules/ editor/ src/ Entity/ Editor.php, line 30 - Contains \Drupal\editor\Entity\Editor.
Namespace
Drupal\editor\EntityView source
class Editor extends ConfigEntityBase implements EditorInterface {
/**
* The machine name of the text format with which this configured text editor
* is associated.
*
* @var string
*
* @see getFilterFormat()
*/
protected $format;
/**
* The name (plugin ID) of the text editor.
*
* @var string
*/
protected $editor;
/**
* The structured array of text editor plugin-specific settings.
*
* @var array
*/
protected $settings = array();
/**
* The structured array of image upload settings.
*
* @var array
*/
protected $image_upload = array();
/**
* The filter format this text editor is associated with.
*
* @var \Drupal\filter\FilterFormatInterface
*/
protected $filterFormat;
/**
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $editorPluginManager;
/**
* {@inheritdoc}
*/
public function id() {
return $this->format;
}
/**
* {@inheritdoc}
*/
public function __construct(array $values, $entity_type) {
parent::__construct($values, $entity_type);
$plugin = $this
->editorPluginManager()
->createInstance($this->editor);
$this->settings += $plugin
->getDefaultSettings();
}
/**
* {@inheritdoc}
*/
public function label() {
return $this
->getFilterFormat()
->label();
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
// Create a dependency on the associated FilterFormat.
$this
->addDependency('config', $this
->getFilterFormat()
->getConfigDependencyName());
// @todo use EntityWithPluginCollectionInterface so configuration between
// config entity and dependency on provider is managed automatically.
$definition = $this
->editorPluginManager()
->createInstance($this->editor)
->getPluginDefinition();
$this
->addDependency('module', $definition['provider']);
return $this;
}
/**
* {@inheritdoc}
*/
public function hasAssociatedFilterFormat() {
return $this->format !== NULL;
}
/**
* {@inheritdoc}
*/
public function getFilterFormat() {
if (!$this->filterFormat) {
$this->filterFormat = \Drupal::entityManager()
->getStorage('filter_format')
->load($this->format);
}
return $this->filterFormat;
}
/**
* Returns the editor plugin manager.
*
* @return \Drupal\Component\Plugin\PluginManagerInterface
*/
protected function editorPluginManager() {
if (!$this->editorPluginManager) {
$this->editorPluginManager = \Drupal::service('plugin.manager.editor');
}
return $this->editorPluginManager;
}
/**
* {@inheritdoc}
*/
public function getEditor() {
return $this->editor;
}
/**
* {@inheritdoc}
*/
public function setEditor($editor) {
$this->editor = $editor;
return $this;
}
/**
* {@inheritdoc}
*/
public function getSettings() {
return $this->settings;
}
/**
* {@inheritdoc}
*/
public function setSettings(array $settings) {
$this->settings = $settings;
return $this;
}
/**
* {@inheritdoc}
*/
public function getImageUploadSettings() {
return $this->image_upload;
}
/**
* {@inheritdoc}
*/
public function setImageUploadSettings(array $image_upload_settings) {
$this->image_upload = $image_upload_settings;
return $this;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityBase:: |
private | property | Whether the config is being created, updated or deleted through the import process. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The name of the property that is used to store plugin configuration. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 2 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides Entity:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides Entity:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides Entity:: |
7 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides Entity:: |
12 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the status of the isSyncing flag. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides Entity:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides Entity:: |
|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | 1 |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
Editor:: |
protected | property | The name (plugin ID) of the text editor. | |
Editor:: |
protected | property | ||
Editor:: |
protected | property | The filter format this text editor is associated with. | |
Editor:: |
protected | property | The machine name of the text format with which this configured text editor is associated. | |
Editor:: |
protected | property | The structured array of image upload settings. | |
Editor:: |
protected | property | The structured array of text editor plugin-specific settings. | |
Editor:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase:: |
|
Editor:: |
protected | function | Returns the editor plugin manager. | |
Editor:: |
public | function |
Returns the associated text editor plugin ID. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Returns the filter format this text editor is associated with. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Returns the image upload settings. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Returns the text editor plugin-specific settings. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Returns whether this text editor has an associated filter format. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Gets the identifier. Overrides Entity:: |
|
Editor:: |
public | function |
Gets the label of the entity. Overrides Entity:: |
|
Editor:: |
public | function |
Set the text editor plugin ID. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Sets the image upload settings. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Sets the text editor plugin-specific settings. Overrides EditorInterface:: |
|
Editor:: |
public | function |
Constructs an Entity object. Overrides ConfigEntityBase:: |
|
Entity:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
Entity:: |
protected | property | The entity type. | |
Entity:: |
protected | property | A typed data object wrapping this entity. | |
Entity:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
Entity:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Gets the entity manager. | |
Entity:: |
protected | function | Gets the entity type manager. | |
Entity:: |
public | function |
The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets the language manager. | |
Entity:: |
protected | function | Gets an array link templates. | 1 |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public | function |
Acts on an entity after it is created but before hooks are invoked. Overrides EntityInterface:: |
4 |
Entity:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
14 |
Entity:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
20 |
Entity:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
6 |
Entity:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Gets an array of placeholders for this entity. | 1 |
Entity:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets the UUID generator. | |
Entity:: |
public | function | 5 | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
RefinableCacheableDependencyTrait:: |
protected | property | Cache contexts. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache max-age. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache tags. | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function |