class NodeStorage

Same name and namespace in other branches
  1. 11.x core/modules/node/src/NodeStorage.php \Drupal\node\NodeStorage
  2. 10 core/modules/node/src/NodeStorage.php \Drupal\node\NodeStorage
  3. 9 core/modules/node/src/NodeStorage.php \Drupal\node\NodeStorage
  4. 8.9.x core/modules/node/src/NodeStorage.php \Drupal\node\NodeStorage

Defines the storage handler class for nodes.

This extends the base storage class, adding required special handling for node entities.

Hierarchy

Expanded class hierarchy of NodeStorage

1 file declares its use of NodeStorage
Node.php in core/modules/node/src/Entity/Node.php

File

View on git.drupalcode.org

core/modules/node/src/NodeStorage.php, line 15

Namespace

Drupal\node
View source 
class NodeStorage extends SqlContentEntityStorage implements NodeStorageInterface {
  
  /**
   * {@inheritdoc}
   */
  public function revisionIds(NodeInterface $node) {
    @trigger_error(__CLASS__ . "::" . __FUNCTION__ . " is deprecated in drupal:11.3.0 and is removed from drupal:13.0.0. Use an entity query instead. See https://www.drupal.org/node/3519187", E_USER_DEPRECATED);
    return $this->database
      ->query('SELECT [vid] FROM {' . $this->getRevisionTable() . '} WHERE [nid] = :nid ORDER BY [vid]', [
      ':nid' => $node->id(),
    ])
      ->fetchCol();
  }
  
  /**
   * {@inheritdoc}
   */
  public function userRevisionIds(AccountInterface $account) {
    @trigger_error(__CLASS__ . "::" . __FUNCTION__ . " is deprecated in drupal:11.3.0 and is removed from drupal:13.0.0. Use an entity query instead. See https://www.drupal.org/node/3519187", E_USER_DEPRECATED);
    return $this->database
      ->query('SELECT [vid] FROM {' . $this->getRevisionDataTable() . '} WHERE [uid] = :uid ORDER BY [vid]', [
      ':uid' => $account->id(),
    ])
      ->fetchCol();
  }
  
  /**
   * {@inheritdoc}
   */
  public function countDefaultLanguageRevisions(NodeInterface $node) {
    @trigger_error(__CLASS__ . "::" . __FUNCTION__ . " is deprecated in drupal:11.3.0 and is removed from drupal:13.0.0. There is no replacement. See https://www.drupal.org/node/3519187", E_USER_DEPRECATED);
    return $this->database
      ->query('SELECT COUNT(*) FROM {' . $this->getRevisionDataTable() . '} WHERE [nid] = :nid AND [default_langcode] = 1', [
      ':nid' => $node->id(),
    ])
      ->fetchField();
  }
  
  /**
   * {@inheritdoc}
   */
  public function updateType($old_type, $new_type) {
    @trigger_error(__CLASS__ . "::" . __FUNCTION__ . " is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. There is no replacement. See https://www.drupal.org/node/3515214", E_USER_DEPRECATED);
    return $this->database
      ->update($this->getBaseTable())
      ->fields([
      'type' => $new_type,
    ])
      ->condition('type', $old_type)
      ->execute();
  }
  
  /**
   * {@inheritdoc}
   */
  public function clearRevisionsLanguage(LanguageInterface $language) {
    return $this->database
      ->update($this->getRevisionTable())
      ->fields([
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ])
      ->condition('langcode', $language->getId())
      ->execute();
  }

}

Members

Title Modifiers Object type Summary Overriden Title
ContentEntityStorageBase::$bundleKey protected property The entity bundle key.
ContentEntityStorageBase::$cacheBackend protected property Cache backend.
ContentEntityStorageBase::$entityFieldManager protected property The entity field manager service.
ContentEntityStorageBase::$entityTypeBundleInfo protected property The entity bundle info.
ContentEntityStorageBase::$ignoreStaticRevisionCache protected property Whether the static revision cache should be ignored.
ContentEntityStorageBase::buildRevisionCacheId protected function Builds the cache ID for the passed in revision ID.
ContentEntityStorageBase::cleanIds protected function Ensures integer entity key values are valid.
ContentEntityStorageBase::create public function
ContentEntityStorageBase::createRevision public function
ContentEntityStorageBase::createTranslation public function
ContentEntityStorageBase::createWithSampleValues public function
ContentEntityStorageBase::deleteRevision public function
ContentEntityStorageBase::doCreate protected function
ContentEntityStorageBase::doDelete protected function
ContentEntityStorageBase::doPostSave protected function
ContentEntityStorageBase::doPreSave protected function
ContentEntityStorageBase::doSave protected function
ContentEntityStorageBase::getBundleFromClass public function
ContentEntityStorageBase::getBundleFromValues protected function Retrieves the bundle from an array of values.
ContentEntityStorageBase::getEntityClass public function
ContentEntityStorageBase::getFromPersistentCache protected function Gets entities from the persistent cache backend.
ContentEntityStorageBase::getFromPersistentRevisionCache protected function Gets entity revisions from the persistent cache backend.
ContentEntityStorageBase::getFromStaticRevisionCache protected function Gets entity revisions from the static cache.
ContentEntityStorageBase::getGroupedEntitiesFromRevisions protected function Splits revisions into groups which are keyed by entity ID.
ContentEntityStorageBase::getLatestRevisionId public function
ContentEntityStorageBase::getLatestTranslationAffectedRevisionId public function
ContentEntityStorageBase::getRevisionTranslationMergeSkippedFieldNames protected function Returns an array of field names to skip when merging revision translations.
ContentEntityStorageBase::hasFieldValueChanged protected function Checks whether the field values changed compared to the original entity.
ContentEntityStorageBase::initFieldValues protected function Initializes field values.
ContentEntityStorageBase::invokeFieldMethod protected function Invokes a method on the Field objects within an entity.
ContentEntityStorageBase::invokeFieldPostSave protected function Invokes the post save method on the Field objects within an entity.
ContentEntityStorageBase::invokeHook protected function
ContentEntityStorageBase::invokeStorageLoadHook protected function Invokes hook_entity_storage_load().
ContentEntityStorageBase::invokeTranslationHooks protected function Checks translation statuses and invokes the related hooks if needed.
ContentEntityStorageBase::isAnyRevisionTranslated protected function Checks whether any entity revision is translated.
ContentEntityStorageBase::isAnyStoredRevisionTranslated protected function Checks whether any stored entity revision is translated.
ContentEntityStorageBase::loadMultipleRevisions public function
ContentEntityStorageBase::loadRevision public function
ContentEntityStorageBase::loadRevisionUnchanged public function
ContentEntityStorageBase::loadUnchanged public function
ContentEntityStorageBase::onFieldDefinitionCreate public function
ContentEntityStorageBase::onFieldDefinitionUpdate public function
ContentEntityStorageBase::populateAffectedRevisionTranslations protected function Populates the affected flag for all the revision translations.
ContentEntityStorageBase::preLoad protected function
ContentEntityStorageBase::purgeFieldData public function
ContentEntityStorageBase::resetCache public function Resets the entity cache.
ContentEntityStorageBase::resetRevisionCache protected function Resets the static and persistent revision caches.
ContentEntityStorageBase::setPersistentCache protected function Stores entities in the persistent cache backend.
ContentEntityStorageBase::setPersistentRevisionCache protected function Stores revisions in the persistent cache backend.
ContentEntityStorageBase::setStaticCache protected function Stores entities in the static entity and entity revision cache.
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
DependencySerializationTrait::__wakeup public function
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on.
EntityHandlerBase::moduleHandler protected function Gets the module handler.
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityStorageBase::$baseEntityClass private property Name of the base entity class.
EntityStorageBase::$entityIdsToLoad protected property Entity IDs awaiting loading.
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::$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.
EntityStorageBase::$uuidService protected property The UUID service.
EntityStorageBase::buildCacheId protected function Builds the cache ID for the passed in entity ID.
EntityStorageBase::getAggregateQuery public function
EntityStorageBase::getEntitiesByClass protected function Indexes the given array of entities by their class name and ID.
EntityStorageBase::getEntityType public function
EntityStorageBase::getEntityTypeId public function
EntityStorageBase::getFromStaticCache protected function Gets entities from the static cache.
EntityStorageBase::getQuery public function
EntityStorageBase::hasData public function
EntityStorageBase::load public function
EntityStorageBase::loadByProperties public function
EntityStorageBase::loadMultiple public function
EntityStorageBase::postLoad protected function Attaches data to entities upon loading.
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.
NodeStorage::clearRevisionsLanguage public function Unsets the language for all nodes with the given language. Overrides NodeStorageInterface::clearRevisionsLanguage
NodeStorage::countDefaultLanguageRevisions public function Counts the number of revisions in the default language. Overrides NodeStorageInterface::countDefaultLanguageRevisions
NodeStorage::revisionIds public function Gets a list of node revision IDs for a specific node. Overrides NodeStorageInterface::revisionIds
NodeStorage::updateType public function Updates all nodes of one type to be of another type. Overrides NodeStorageInterface::updateType
NodeStorage::userRevisionIds public function Gets a list of revision IDs having a given user as node author. Overrides NodeStorageInterface::userRevisionIds
SqlContentEntityStorage::$baseTable protected property The base table of the entity.
SqlContentEntityStorage::$database protected property Active database connection.
SqlContentEntityStorage::$dataTable protected property The table that stores properties, if the entity has multilingual support.
SqlContentEntityStorage::$defaultLangcodeKey protected property The default language entity key.
SqlContentEntityStorage::$entityTypeManager protected property The entity type manager.
SqlContentEntityStorage::$fieldStorageDefinitions protected property The entity type's field storage definitions.
SqlContentEntityStorage::$langcodeKey protected property The entity langcode key.
SqlContentEntityStorage::$languageManager protected property The language manager.
SqlContentEntityStorage::$revisionDataTable protected property The table that stores revision field data if the entity supports revisions.
SqlContentEntityStorage::$revisionKey protected property Name of entity's revision database table field, if it supports revisions.
SqlContentEntityStorage::$revisionTable protected property The table that stores revisions, if the entity supports revisions.
SqlContentEntityStorage::$storageSchema protected property The entity type's storage schema object.
SqlContentEntityStorage::$tableMapping protected property The mapping of field columns to SQL tables.
SqlContentEntityStorage::$temporary protected property Whether this storage should use the temporary table mapping.
SqlContentEntityStorage::buildPropertyQuery protected function
SqlContentEntityStorage::buildQuery protected function Builds the query to load the entity.
SqlContentEntityStorage::countFieldData public function
SqlContentEntityStorage::createInstance public static function
SqlContentEntityStorage::delete public function
SqlContentEntityStorage::deleteFromDedicatedTables protected function Deletes values of fields in dedicated tables for all revisions.
SqlContentEntityStorage::deleteRevisionFromDedicatedTables protected function Deletes values of fields in dedicated tables for all revisions.
SqlContentEntityStorage::doDeleteFieldItems protected function
SqlContentEntityStorage::doDeleteRevisionFieldItems protected function
SqlContentEntityStorage::doLoadMultiple protected function
SqlContentEntityStorage::doLoadMultipleRevisionsFieldItems protected function
SqlContentEntityStorage::doSaveFieldItems protected function
SqlContentEntityStorage::finalizePurge public function
SqlContentEntityStorage::getBaseTable public function Gets the base table name.
SqlContentEntityStorage::getCustomTableMapping public function Gets a table mapping for the specified entity type and storage definitions.
SqlContentEntityStorage::getDataTable public function Gets the data table name.
SqlContentEntityStorage::getFromStorage protected function Gets entities from the storage.
SqlContentEntityStorage::getQueryServiceName protected function
SqlContentEntityStorage::getRevisionDataTable public function Gets the revision data table name.
SqlContentEntityStorage::getRevisionTable public function Gets the revision table name.
SqlContentEntityStorage::getStorageSchema protected function Gets the entity type's storage schema object.
SqlContentEntityStorage::getTableMapping public function
SqlContentEntityStorage::handleNullableFieldUnserialize protected function Handles NULL values before passing data to unserialize().
SqlContentEntityStorage::has protected function
SqlContentEntityStorage::initTableLayout protected function Initializes table name variables.
SqlContentEntityStorage::isColumnSerial protected function Checks whether a field column should be treated as serial.
SqlContentEntityStorage::loadFromDedicatedTables protected function Loads values of fields stored in dedicated tables for a group of entities.
SqlContentEntityStorage::loadFromSharedTables protected function Loads values for fields stored in the shared data tables.
SqlContentEntityStorage::mapFromStorageRecords protected function Maps from storage records to entity objects, and attaches fields.
SqlContentEntityStorage::mapToDataStorageRecord protected function Maps from an entity object to the storage record of the field data.
SqlContentEntityStorage::mapToStorageRecord protected function Maps from an entity object to the storage record.
SqlContentEntityStorage::onBundleCreate public function
SqlContentEntityStorage::onBundleDelete public function
SqlContentEntityStorage::onEntityTypeCreate public function
SqlContentEntityStorage::onEntityTypeDelete public function
SqlContentEntityStorage::onEntityTypeUpdate public function
SqlContentEntityStorage::onFieldableEntityTypeCreate public function
SqlContentEntityStorage::onFieldableEntityTypeUpdate public function
SqlContentEntityStorage::onFieldDefinitionDelete public function
SqlContentEntityStorage::onFieldStorageDefinitionCreate public function
SqlContentEntityStorage::onFieldStorageDefinitionDelete public function
SqlContentEntityStorage::onFieldStorageDefinitionUpdate public function
SqlContentEntityStorage::purgeFieldItems protected function
SqlContentEntityStorage::readFieldItemsToPurge protected function
SqlContentEntityStorage::requiresEntityDataMigration public function
SqlContentEntityStorage::requiresEntityStorageSchemaChanges public function
SqlContentEntityStorage::requiresFieldDataMigration public function
SqlContentEntityStorage::requiresFieldStorageSchemaChanges public function
SqlContentEntityStorage::restore public function
SqlContentEntityStorage::save public function
SqlContentEntityStorage::saveRevision protected function Saves an entity revision.
SqlContentEntityStorage::saveToDedicatedTables protected function Saves values of fields that use dedicated tables.
SqlContentEntityStorage::saveToSharedTables protected function Saves fields that use the shared tables.
SqlContentEntityStorage::setEntityType public function Updates the wrapped entity type definition.
SqlContentEntityStorage::setFieldStorageDefinitions public function Updates the internal list of field storage definitions.
SqlContentEntityStorage::setTableMapping public function Sets the wrapped table mapping definition.
SqlContentEntityStorage::setTemporary public function Changes the temporary state of the storage.
SqlContentEntityStorage::wrapSchemaException protected function Wraps a database schema exception into an entity storage exception.
SqlContentEntityStorage::__construct public function Constructs a SqlContentEntityStorage object.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
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.