NodeStorageInterface.php

Same filename in other branches
  1. 9 core/modules/node/src/NodeStorageInterface.php
  2. 10 core/modules/node/src/NodeStorageInterface.php
  3. 11.x core/modules/node/src/NodeStorageInterface.php

Namespace

Drupal\node

File

core/modules/node/src/NodeStorageInterface.php

View source
<?php

namespace Drupal\node;

use Drupal\Core\Entity\ContentEntityStorageInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Session\AccountInterface;

/**
 * Defines an interface for node entity storage classes.
 */
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);

}

Interfaces

Title Deprecated Summary
NodeStorageInterface Defines an interface for node entity storage classes.

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