NodeStorageInterface.php 1.73 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\node;

5
use Drupal\Core\Entity\ContentEntityStorageInterface;
6
use Drupal\Core\Language\LanguageInterface;
7 8 9
use Drupal\Core\Session\AccountInterface;

/**
10
 * Defines an interface for node entity storage classes.
11
 */
12
interface NodeStorageInterface extends ContentEntityStorageInterface {
13 14

  /**
15
   * Gets a list of node revision IDs for a specific node.
16
   *
17
   * @param \Drupal\node\NodeInterface $node
18 19 20 21 22 23 24 25
   *   The node entity.
   *
   * @return int[]
   *   Node revision IDs (in ascending order).
   */
  public function revisionIds(NodeInterface $node);

  /**
26
   * Gets a list of revision IDs having a given user as node author.
27 28 29 30 31 32 33 34 35
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user entity.
   *
   * @return int[]
   *   Node revision IDs (in ascending order).
   */
  public function userRevisionIds(AccountInterface $account);

36 37 38
  /**
   * Counts the number of revisions in the default language.
   *
39
   * @param \Drupal\node\NodeInterface $node
40 41 42 43 44 45 46
   *   The node entity.
   *
   * @return int
   *   The number of revisions in the default language.
   */
  public function countDefaultLanguageRevisions(NodeInterface $node);

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
  /**
   * 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.
   *
63
   * @param \Drupal\Core\Language\LanguageInterface $language
64
   *   The language object.
65
   */
66
  public function clearRevisionsLanguage(LanguageInterface $language);
67

68
}