class KeyValueEntityStorage
Provides a key value backend for entities.
@todo Entities that depend on auto-incrementing serial IDs need to explicitly provide an ID until a generic wrapper around the functionality provided by \Drupal\Core\Database\Connection::nextId() is added and used. @todo Revisions are currently not supported.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface extends \Drupal\Core\Entity\EntityHandlerBase
- class \Drupal\Core\Entity\KeyValueStore\KeyValueEntityStorage extends \Drupal\Core\Entity\EntityStorageBase
 
 
 - class \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface extends \Drupal\Core\Entity\EntityHandlerBase
 
Expanded class hierarchy of KeyValueEntityStorage
1 file declares its use of KeyValueEntityStorage
- KeyValueEntityStorageTest.php in core/
tests/ Drupal/ Tests/ Core/ Entity/ KeyValueStore/ KeyValueEntityStorageTest.php  
File
- 
              core/
lib/ Drupal/ Core/ Entity/ KeyValueStore/ KeyValueEntityStorage.php, line 25  
Namespace
Drupal\Core\Entity\KeyValueStoreView source
class KeyValueEntityStorage extends EntityStorageBase {
  
  /**
   * Length limit of the entity ID.
   */
  const MAX_ID_LENGTH = 128;
  
  /**
   * The key value store.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueStoreInterface
   */
  protected $keyValueStore;
  
  /**
   * The UUID service.
   *
   * @var \Drupal\Component\Uuid\UuidInterface
   */
  protected $uuidService;
  
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;
  
  /**
   * Constructs a new KeyValueEntityStorage.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   * @param \Drupal\Core\KeyValueStore\KeyValueStoreInterface $key_value_store
   *   The key value store.
   * @param \Drupal\Component\Uuid\UuidInterface $uuid_service
   *   The UUID service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Cache\MemoryCache\MemoryCacheInterface $memory_cache
   *   The memory cache.
   */
  public function __construct(EntityTypeInterface $entity_type, KeyValueStoreInterface $key_value_store, UuidInterface $uuid_service, LanguageManagerInterface $language_manager, MemoryCacheInterface $memory_cache) {
    parent::__construct($entity_type, $memory_cache);
    $this->keyValueStore = $key_value_store;
    $this->uuidService = $uuid_service;
    $this->languageManager = $language_manager;
    // Check if the entity type supports UUIDs.
    $this->uuidKey = $this->entityType
      ->getKey('uuid');
  }
  
  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container->get('keyvalue')
      ->get('entity_storage__' . $entity_type->id()), $container->get('uuid'), $container->get('language_manager'), $container->get('entity.memory_cache'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function doCreate(array $values = []) {
    // Set default language to site default if not provided.
    $values += [
      $this->getEntityType()
        ->getKey('langcode') => $this->languageManager
        ->getDefaultLanguage()
        ->getId(),
    ];
    $entity_class = $this->getEntityClass();
    $entity = new $entity_class($values, $this->entityTypeId);
    // @todo This is handled by ContentEntityStorageBase, which assumes
    //   FieldableEntityInterface. The current approach in
    //   https://www.drupal.org/node/1867228 improves this but does not solve it
    //   completely.
    if ($entity instanceof FieldableEntityInterface) {
      foreach ($entity as $name => $field) {
        if (isset($values[$name])) {
          $entity->{$name} = $values[$name];
        }
        elseif (!array_key_exists($name, $values)) {
          $entity->get($name)
            ->applyDefaultValue();
        }
        unset($values[$name]);
      }
    }
    return $entity;
  }
  
  /**
   * {@inheritdoc}
   */
  public function doLoadMultiple(array $ids = NULL) {
    if (empty($ids)) {
      $entities = $this->keyValueStore
        ->getAll();
    }
    else {
      $entities = $this->keyValueStore
        ->getMultiple($ids);
    }
    return $this->mapFromStorageRecords($entities);
  }
  
  /**
   * {@inheritdoc}
   */
  public function loadRevision($revision_id) {
    return NULL;
  }
  
  /**
   * {@inheritdoc}
   */
  public function deleteRevision($revision_id) {
    return NULL;
  }
  
  /**
   * {@inheritdoc}
   */
  public function doDelete($entities) {
    $entity_ids = array_keys($entities);
    $this->keyValueStore
      ->deleteMultiple($entity_ids);
  }
  
  /**
   * {@inheritdoc}
   */
  public function save(EntityInterface $entity) {
    $id = $entity->id();
    if ($id === NULL || $id === '') {
      throw new EntityMalformedException('The entity does not have an ID.');
    }
    // Check the entity ID length.
    // @todo This is not config-specific, but serial IDs will likely never hit
    //   this limit. Consider renaming the exception class.
    if (strlen($entity->id()) > static::MAX_ID_LENGTH) {
      throw new ConfigEntityIdLengthException("Entity ID {$entity->id()} exceeds maximum allowed length of " . static::MAX_ID_LENGTH . ' characters.');
    }
    return parent::save($entity);
  }
  
  /**
   * {@inheritdoc}
   */
  protected function doSave($id, EntityInterface $entity) {
    $is_new = $entity->isNew();
    // Save the entity data in the key value store.
    $this->keyValueStore
      ->set($entity->id(), $entity->toArray());
    // If this is a rename, delete the original entity.
    if ($this->has($id, $entity) && $id !== $entity->id()) {
      $this->keyValueStore
        ->delete($id);
    }
    return $is_new ? SAVED_NEW : SAVED_UPDATED;
  }
  
  /**
   * {@inheritdoc}
   */
  protected function has($id, EntityInterface $entity) {
    return $this->keyValueStore
      ->has($id);
  }
  
  /**
   * {@inheritdoc}
   */
  public function hasData() {
    return (bool) $this->keyValueStore
      ->getAll();
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getQueryServiceName() {
    return 'entity.query.keyvalue';
  }
}
Members
| Title Sort descending | 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| EntityHandlerBase::$moduleHandler | protected | property | The module handler to invoke hooks on. | 5 | |
| EntityHandlerBase::moduleHandler | protected | function | Gets the module handler. | 5 | |
| EntityHandlerBase::setModuleHandler | public | function | Sets the module handler for this handler. | ||
| EntityStorageBase::$baseEntityClass | private | property | Name of the base entity class. | ||
| EntityStorageBase::$entityType | protected | property | Information about the entity type. | ||
| EntityStorageBase::$entityTypeId | protected | property | Entity type ID for this storage. | ||
| EntityStorageBase::$idKey | protected | property | Name of the entity's ID field in the entity database table. | ||
| EntityStorageBase::$langcodeKey | protected | property | The name of the entity langcode property. | 1 | |
| EntityStorageBase::$memoryCache | protected | property | The memory cache. | ||
| EntityStorageBase::$memoryCacheTag | protected | property | The memory cache tag. | ||
| EntityStorageBase::$uuidKey | protected | property | Name of entity's UUID database table field, if it supports UUIDs. | 1 | |
| EntityStorageBase::buildCacheId | protected | function | Builds the cache ID for the passed in entity ID. | 1 | |
| EntityStorageBase::buildPropertyQuery | protected | function | Builds an entity query. | 1 | |
| EntityStorageBase::create | public | function | Constructs a new entity object, without permanently saving it. | Overrides EntityStorageInterface::create | 1 | 
| EntityStorageBase::delete | public | function | Deletes permanently saved entities. | Overrides EntityStorageInterface::delete | 2 | 
| EntityStorageBase::doPostSave | protected | function | Performs post save entity processing. | 1 | |
| EntityStorageBase::doPreSave | protected | function | Performs presave entity processing. | 1 | |
| EntityStorageBase::getAggregateQuery | public | function | Gets an aggregated query instance. | Overrides EntityStorageInterface::getAggregateQuery | |
| EntityStorageBase::getEntitiesByClass | protected | function | Indexes the given array of entities by their class name and ID. | ||
| EntityStorageBase::getEntityClass | public | function | Retrieves the class name used to create the entity. | Overrides EntityStorageInterface::getEntityClass | 1 | 
| EntityStorageBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityStorageInterface::getEntityType | |
| EntityStorageBase::getEntityTypeId | public | function | Gets the entity type ID. | Overrides EntityStorageInterface::getEntityTypeId | |
| EntityStorageBase::getFromStaticCache | protected | function | Gets entities from the static cache. | ||
| EntityStorageBase::getQuery | public | function | Gets an entity query instance. | Overrides EntityStorageInterface::getQuery | |
| EntityStorageBase::invokeHook | protected | function | Invokes a hook on behalf of the entity. | 2 | |
| EntityStorageBase::load | public | function | Loads one entity. | Overrides EntityStorageInterface::load | 2 | 
| EntityStorageBase::loadByProperties | public | function | Load entities by their property values without any access checks. | Overrides EntityStorageInterface::loadByProperties | 3 | 
| EntityStorageBase::loadMultiple | public | function | Loads one or more entities. | Overrides EntityStorageInterface::loadMultiple | 1 | 
| EntityStorageBase::loadUnchanged | public | function | Loads an unchanged entity from the database. | Overrides EntityStorageInterface::loadUnchanged | 1 | 
| EntityStorageBase::mapFromStorageRecords | protected | function | Maps from storage records to entity objects. | 4 | |
| EntityStorageBase::postLoad | protected | function | Attaches data to entities upon loading. | ||
| EntityStorageBase::preLoad | protected | function | Gathers entities from a 'preload' step. | 1 | |
| EntityStorageBase::resetCache | public | function | Resets the internal entity cache. | Overrides EntityStorageInterface::resetCache | 1 | 
| EntityStorageBase::restore | public | function | Restores a previously saved entity. | Overrides EntityStorageInterface::restore | 1 | 
| EntityStorageBase::setStaticCache | protected | function | Stores entities in the static entity cache. | ||
| EntityStorageBase::__get | public | function | Warns subclasses not to directly access the deprecated entityClass property. | ||
| EntityStorageBase::__set | public | function | Warns subclasses not to directly set the deprecated entityClass property. | ||
| 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. | |||
| KeyValueEntityStorage::$keyValueStore | protected | property | The key value store. | ||
| KeyValueEntityStorage::$languageManager | protected | property | The language manager. | ||
| KeyValueEntityStorage::$uuidService | protected | property | The UUID service. | Overrides EntityStorageBase::$uuidService | |
| KeyValueEntityStorage::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides EntityHandlerInterface::createInstance | |
| KeyValueEntityStorage::deleteRevision | public | function | Delete a specific entity revision. | Overrides EntityStorageInterface::deleteRevision | |
| KeyValueEntityStorage::doCreate | public | function | Performs storage-specific creation of entities. | Overrides EntityStorageBase::doCreate | |
| KeyValueEntityStorage::doDelete | public | function | Performs storage-specific entity deletion. | Overrides EntityStorageBase::doDelete | |
| KeyValueEntityStorage::doLoadMultiple | public | function | Performs storage-specific loading of entities. | Overrides EntityStorageBase::doLoadMultiple | |
| KeyValueEntityStorage::doSave | protected | function | Performs storage-specific saving of the entity. | Overrides EntityStorageBase::doSave | |
| KeyValueEntityStorage::getQueryServiceName | protected | function | Gets the name of the service for the query for this entity storage. | Overrides EntityStorageBase::getQueryServiceName | |
| KeyValueEntityStorage::has | protected | function | Determines if this entity already exists in storage. | Overrides EntityStorageBase::has | |
| KeyValueEntityStorage::hasData | public | function | Determines if the storage contains any data. | Overrides EntityStorageBase::hasData | |
| KeyValueEntityStorage::loadRevision | public | function | Load a specific entity revision. | Overrides EntityStorageInterface::loadRevision | |
| KeyValueEntityStorage::MAX_ID_LENGTH | constant | Length limit of the entity ID. | |||
| KeyValueEntityStorage::save | public | function | Saves the entity permanently. | Overrides EntityStorageBase::save | |
| KeyValueEntityStorage::__construct | public | function | Constructs a new KeyValueEntityStorage. | Overrides EntityStorageBase::__construct | |
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.