interface ConfigEntityStorageInterface

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Config/Entity/ConfigEntityStorageInterface.php \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
  2. 10 core/lib/Drupal/Core/Config/Entity/ConfigEntityStorageInterface.php \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
  3. 11.x core/lib/Drupal/Core/Config/Entity/ConfigEntityStorageInterface.php \Drupal\Core\Config\Entity\ConfigEntityStorageInterface

Provides an interface for configuration entity storage.

Hierarchy

Expanded class hierarchy of ConfigEntityStorageInterface

All classes that implement ConfigEntityStorageInterface

5 files declare their use of ConfigEntityStorageInterface
DateFormatFormBase.php in core/modules/system/src/Form/DateFormatFormBase.php
ImageStyleStorageInterface.php in core/modules/image/src/ImageStyleStorageInterface.php
RoleStorageInterface.php in core/modules/user/src/RoleStorageInterface.php
ShortcutSetStorageInterface.php in core/modules/shortcut/src/ShortcutSetStorageInterface.php
VocabularyStorageInterface.php in core/modules/taxonomy/src/VocabularyStorageInterface.php

File

core/lib/Drupal/Core/Config/Entity/ConfigEntityStorageInterface.php, line 10

Namespace

Drupal\Core\Config\Entity
View source
interface ConfigEntityStorageInterface extends EntityStorageInterface {
    
    /**
     * Extracts the configuration entity ID from the full configuration name.
     *
     * @param string $config_name
     *   The full configuration name to extract the ID from; for example,
     *   'views.view.archive'.
     * @param string $config_prefix
     *   The config prefix of the configuration entity; for example, 'views.view'.
     *
     * @return string
     *   The ID of the configuration entity.
     */
    public static function getIDFromConfigName($config_name, $config_prefix);
    
    /**
     * Creates a configuration entity from storage values.
     *
     * Allows the configuration entity storage to massage storage values before
     * creating an entity.
     *
     * @param array $values
     *   The array of values from the configuration storage.
     *
     * @return ConfigEntityInterface
     *   The configuration entity.
     *
     * @see \Drupal\Core\Entity\EntityStorageBase::mapFromStorageRecords()
     * @see \Drupal\field\FieldStorageConfigStorage::mapFromStorageRecords()
     */
    public function createFromStorageRecord(array $values);
    
    /**
     * Updates a configuration entity from storage values.
     *
     * Allows the configuration entity storage to massage storage values before
     * updating an entity.
     *
     * @param ConfigEntityInterface $entity
     *   The configuration entity to update.
     * @param array $values
     *   The array of values from the configuration storage.
     *
     * @return ConfigEntityInterface
     *   The configuration entity.
     *
     * @see \Drupal\Core\Entity\EntityStorageBase::mapFromStorageRecords()
     * @see \Drupal\field\FieldStorageConfigStorage::mapFromStorageRecords()
     */
    public function updateFromStorageRecord(ConfigEntityInterface $entity, array $values);
    
    /**
     * Loads one entity in their original form without overrides.
     *
     * @param mixed $id
     *   The ID of the entity to load.
     *
     * @return \Drupal\Core\Entity\EntityInterface|null
     *   An entity object. NULL if no matching entity is found.
     */
    public function loadOverrideFree($id);
    
    /**
     * Loads one or more entities in their original form without overrides.
     *
     * @param $ids
     *   An array of entity IDs, or NULL to load all entities.
     *
     * @return \Drupal\Core\Entity\EntityInterface[]
     *   An array of entity objects indexed by their IDs. Returns an empty array
     *   if no matching entities are found.
     */
    public function loadMultipleOverrideFree(array $ids = NULL);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
ConfigEntityStorageInterface::createFromStorageRecord public function Creates a configuration entity from storage values. 1
ConfigEntityStorageInterface::getIDFromConfigName public static function Extracts the configuration entity ID from the full configuration name. 1
ConfigEntityStorageInterface::loadMultipleOverrideFree public function Loads one or more entities in their original form without overrides. 1
ConfigEntityStorageInterface::loadOverrideFree public function Loads one entity in their original form without overrides. 1
ConfigEntityStorageInterface::updateFromStorageRecord public function Updates a configuration entity from storage values. 1
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
EntityStorageInterface::deleteRevision public function Delete a specific entity revision. 4
EntityStorageInterface::FIELD_LOAD_CURRENT constant Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION constant Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery public function Gets an aggregated query instance. 1
EntityStorageInterface::getEntityClass public function Retrieves the class name used to create the entity. 1
EntityStorageInterface::getEntityType public function Gets the entity type definition. 1
EntityStorageInterface::getEntityTypeId public function Gets the entity type ID. 1
EntityStorageInterface::getQuery public function Gets an entity query instance. 1
EntityStorageInterface::hasData public function Determines if the storage contains any data. 1
EntityStorageInterface::load public function Loads one entity. 1
EntityStorageInterface::loadByProperties public function Load entities by their property values without any access checks. 1
EntityStorageInterface::loadMultiple public function Loads one or more entities. 1
EntityStorageInterface::loadRevision public function Load a specific entity revision. 4
EntityStorageInterface::loadUnchanged public function Loads an unchanged entity from the database. 1
EntityStorageInterface::resetCache public function Resets the internal entity cache. 1
EntityStorageInterface::restore public function Restores a previously saved entity. 1
EntityStorageInterface::save public function Saves the entity permanently. 1

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