interface NodeStorageInterface

Same name in other branches
  1. 9 core/modules/node/src/NodeStorageInterface.php \Drupal\node\NodeStorageInterface
  2. 8.9.x core/modules/node/src/NodeStorageInterface.php \Drupal\node\NodeStorageInterface
  3. 10 core/modules/node/src/NodeStorageInterface.php \Drupal\node\NodeStorageInterface

Defines an interface for node entity storage classes.

Hierarchy

Expanded class hierarchy of NodeStorageInterface

All classes that implement NodeStorageInterface

4 files declare their use of NodeStorageInterface
NodeController.php in core/modules/node/src/Controller/NodeController.php
NodeOperationAccessTest.php in core/modules/node/tests/src/Unit/NodeOperationAccessTest.php
TopLevelBook.php in core/modules/book/src/Plugin/views/argument_default/TopLevelBook.php
Vid.php in core/modules/node/src/Plugin/views/argument/Vid.php

File

core/modules/node/src/NodeStorageInterface.php, line 12

Namespace

Drupal\node
View source
interface NodeStorageInterface extends ContentEntityStorageInterface {
    
    /**
     * Gets a list of node revision IDs for a specific node.
     *
     * @param \Drupal\node\NodeInterface $node
     *   The node entity.
     *
     * @return int[]
     *   Node revision IDs (in ascending order).
     */
    public function revisionIds(NodeInterface $node);
    
    /**
     * Gets a list of revision IDs having a given user as node author.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The user entity.
     *
     * @return int[]
     *   Node revision IDs (in ascending order).
     */
    public function userRevisionIds(AccountInterface $account);
    
    /**
     * Counts the number of revisions in the default language.
     *
     * @param \Drupal\node\NodeInterface $node
     *   The node entity.
     *
     * @return int
     *   The number of revisions in the default language.
     */
    public function countDefaultLanguageRevisions(NodeInterface $node);
    
    /**
     * Updates all nodes of one type to be of another type.
     *
     * @param string $old_type
     *   The current node type of the nodes.
     * @param string $new_type
     *   The new node type of the nodes.
     *
     * @return int
     *   The number of nodes whose node type field was modified.
     */
    public function updateType($old_type, $new_type);
    
    /**
     * Unsets the language for all nodes with the given language.
     *
     * @param \Drupal\Core\Language\LanguageInterface $language
     *   The language object.
     */
    public function clearRevisionsLanguage(LanguageInterface $language);

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContentEntityStorageInterface::createWithSampleValues public function Creates an entity with sample field values. 2
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
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::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
NodeStorageInterface::clearRevisionsLanguage public function Unsets the language for all nodes with the given language. 1
NodeStorageInterface::countDefaultLanguageRevisions public function Counts the number of revisions in the default language. 1
NodeStorageInterface::revisionIds public function Gets a list of node revision IDs for a specific node. 1
NodeStorageInterface::updateType public function Updates all nodes of one type to be of another type. 1
NodeStorageInterface::userRevisionIds public function Gets a list of revision IDs having a given user as node author. 1
RevisionableStorageInterface::deleteRevision public function Deletes a specific entity revision. 2
RevisionableStorageInterface::getLatestRevisionId public function Returns the latest revision identifier for an entity. 2
RevisionableStorageInterface::loadMultipleRevisions public function Loads multiple entity revisions. 2
RevisionableStorageInterface::loadRevision public function Loads a specific entity revision. 2
TranslatableRevisionableStorageInterface::createRevision public function Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision 2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId public function Returns the latest revision affecting the specified translation. 2
TranslatableStorageInterface::createTranslation public function Constructs a new entity translation object, without permanently saving it. 2

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