class Editor

Same name in this branch
  1. 11.x core/modules/editor/src/Annotation/Editor.php \Drupal\editor\Annotation\Editor
  2. 11.x core/modules/editor/src/Attribute/Editor.php \Drupal\editor\Attribute\Editor
Same name in other branches
  1. 9 core/modules/quickedit/src/Plugin/InPlaceEditor/Editor.php \Drupal\quickedit\Plugin\InPlaceEditor\Editor
  2. 9 core/modules/editor/src/Entity/Editor.php \Drupal\editor\Entity\Editor
  3. 9 core/modules/editor/src/Annotation/Editor.php \Drupal\editor\Annotation\Editor
  4. 9 core/modules/editor/src/Plugin/InPlaceEditor/Editor.php \Drupal\editor\Plugin\InPlaceEditor\Editor
  5. 8.9.x core/modules/editor/src/Entity/Editor.php \Drupal\editor\Entity\Editor
  6. 8.9.x core/modules/editor/src/Annotation/Editor.php \Drupal\editor\Annotation\Editor
  7. 8.9.x core/modules/editor/src/Plugin/InPlaceEditor/Editor.php \Drupal\editor\Plugin\InPlaceEditor\Editor
  8. 10 core/modules/editor/src/Entity/Editor.php \Drupal\editor\Entity\Editor
  9. 10 core/modules/editor/src/Annotation/Editor.php \Drupal\editor\Annotation\Editor
  10. 10 core/modules/editor/src/Attribute/Editor.php \Drupal\editor\Attribute\Editor

Defines the configured text editor entity.

An Editor entity is created when a filter format entity (Text format) is saved after selecting an editor plugin (eg: CKEditor). The ID of the Editor entity will be same as the ID of the filter format entity in which the editor plugin was selected.

Hierarchy

Expanded class hierarchy of Editor

61 files declare their use of Editor
AddedStylesheetsTest.php in core/modules/ckeditor5/tests/src/Functional/AddedStylesheetsTest.php
AddItemToToolbarConfigActionTest.php in core/modules/ckeditor5/tests/src/Kernel/ConfigAction/AddItemToToolbarConfigActionTest.php
CKEditor5.php in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
CKEditor5AllowedTagsTest.php in core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php
CKEditor5DialogTest.php in core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5DialogTest.php

... See full list

48 string references to 'Editor'
CKEditor5::assessActiveTextEditorAfterBuild in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
Form #after_build callback: provides text editor state changes.
CKEditor5::buildConfigurationForm in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
Form constructor.
CKEditor5::submitConfigurationForm in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
Form submission handler.
CKEditor5::validateConfigurationForm in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
Form validation handler.
Ckeditor5Hooks::formFilterFormatFormAlter in core/modules/ckeditor5/src/Hook/Ckeditor5Hooks.php
Implements hook_form_FORM_ID_alter().

... See full list

File

core/modules/editor/src/Entity/Editor.php, line 21

Namespace

Drupal\editor\Entity
View source
class Editor extends ConfigEntityBase implements EditorInterface {
    
    /**
     * Machine name of the text format for this configured text editor.
     *
     * @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 = [];
    
    /**
     * The structured array of image upload settings.
     *
     * @var array
     */
    protected $image_upload = [];
    
    /**
     * 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);
        try {
            $plugin = $this->editorPluginManager()
                ->createInstance($this->editor);
            $this->settings += $plugin->getDefaultSettings();
        } catch (PluginNotFoundException) {
            // When a Text Editor plugin has gone missing, still allow the Editor
            // config entity to be constructed. The only difference is that default
            // settings are not added.
        }
    }
    
    /**
     * {@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::entityTypeManager()->getStorage('filter_format')
                ->load($this->format);
        }
        return $this->filterFormat;
    }
    
    /**
     * Returns the editor plugin manager.
     *
     * @return \Drupal\Component\Plugin\PluginManagerInterface
     *   The editor plugin manager instance.
     */
    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;
    }
    
    /**
     * Computes all valid choices for the "image_upload.scheme" setting.
     *
     * @see editor.schema.yml
     *
     * @return string[]
     *   All valid choices.
     *
     * @internal
     */
    public static function getValidStreamWrappers() : array {
        return array_keys(\Drupal::service('stream_wrapper_manager')->getNames(StreamWrapperInterface::WRITE_VISIBLE));
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the
config system already invalidates them.
Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system
already invalidates it.
Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides EntityBase::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 2
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set 1
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 3
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
Editor::$editor protected property The name (plugin ID) of the text editor.
Editor::$editorPluginManager protected property
Editor::$filterFormat protected property The filter format this text editor is associated with.
Editor::$format protected property Machine name of the text format for this configured text editor.
Editor::$image_upload protected property The structured array of image upload settings.
Editor::$settings protected property The structured array of text editor plugin-specific settings.
Editor::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
Editor::editorPluginManager protected function Returns the editor plugin manager.
Editor::getEditor public function Returns the associated text editor plugin ID. Overrides EditorInterface::getEditor
Editor::getFilterFormat public function Returns the filter format this text editor is associated with. Overrides EditorInterface::getFilterFormat
Editor::getImageUploadSettings public function Returns the image upload settings. Overrides EditorInterface::getImageUploadSettings
Editor::getSettings public function Returns the text editor plugin-specific settings. Overrides EditorInterface::getSettings
Editor::getValidStreamWrappers public static function Computes all valid choices for the "image_upload.scheme" setting.
Editor::hasAssociatedFilterFormat public function Returns whether this text editor has an associated filter format. Overrides EditorInterface::hasAssociatedFilterFormat
Editor::id public function Gets the identifier. Overrides EntityBase::id
Editor::label public function Gets the label of the entity. Overrides EntityBase::label
Editor::setEditor public function Set the text editor plugin ID. Overrides EditorInterface::setEditor
Editor::setImageUploadSettings public function Sets the image upload settings. Overrides EditorInterface::setImageUploadSettings
Editor::setSettings public function Sets the text editor plugin-specific settings. Overrides EditorInterface::setSettings
Editor::__construct public function Constructs an Entity object. Overrides ConfigEntityBase::__construct
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$originalEntity protected property The original unchanged entity.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 2
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType 1
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getOriginal public function Returns the original unchanged entity. Overrides EntityInterface::getOriginal
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 5
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 17
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 13
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 6
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::setOriginal public function Sets the original unchanged entity. Overrides EntityInterface::setOriginal
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityBase::__get public function 1
EntityBase::__isset public function 1
EntityBase::__set public function 1
EntityBase::__unset public function 1
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.