class KeyValueContentEntityStorage

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

Provides a key value backend for content entities.

Hierarchy

Expanded class hierarchy of KeyValueContentEntityStorage

File

core/lib/Drupal/Core/Entity/KeyValueStore/KeyValueContentEntityStorage.php, line 13

Namespace

Drupal\Core\Entity\KeyValueStore
View source
class KeyValueContentEntityStorage extends KeyValueEntityStorage implements ContentEntityStorageInterface {
    
    /**
     * {@inheritdoc}
     */
    public function createTranslation(ContentEntityInterface $entity, $langcode, array $values = []) {
        // @todo Complete the content entity storage implementation in
        //   https://www.drupal.org/node/2618436.
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasStoredTranslations(TranslatableInterface $entity) {
        return FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function createRevision(RevisionableInterface $entity, $default = TRUE, $keep_untranslatable_fields = NULL) {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function createWithSampleValues($bundle = FALSE, array $values = []) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function loadMultipleRevisions(array $revision_ids) {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getLatestRevisionId($entity_id) {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getLatestTranslationAffectedRevisionId($entity_id, $langcode) {
        return NULL;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 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.
KeyValueContentEntityStorage::createRevision public function Creates a new revision starting off from the specified entity object. Overrides TranslatableRevisionableStorageInterface::createRevision
KeyValueContentEntityStorage::createTranslation public function Constructs a new entity translation object, without permanently saving it. Overrides TranslatableStorageInterface::createTranslation
KeyValueContentEntityStorage::createWithSampleValues public function Creates an entity with sample field values. Overrides ContentEntityStorageInterface::createWithSampleValues
KeyValueContentEntityStorage::getLatestRevisionId public function Returns the latest revision identifier for an entity. Overrides RevisionableStorageInterface::getLatestRevisionId
KeyValueContentEntityStorage::getLatestTranslationAffectedRevisionId public function Returns the latest revision affecting the specified translation. Overrides TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId
KeyValueContentEntityStorage::hasStoredTranslations public function
KeyValueContentEntityStorage::loadMultipleRevisions public function Loads multiple entity revisions. Overrides RevisionableStorageInterface::loadMultipleRevisions
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.