1. 8.3.x core/modules/node/src/NodeInterface.php NodeInterface
  2. 8.0.x core/modules/node/src/NodeInterface.php NodeInterface
  3. 8.0.x vendor/symfony/css-selector/Node/NodeInterface.php NodeInterface
  4. 8.1.x core/modules/node/src/NodeInterface.php NodeInterface
  5. 8.2.x core/modules/node/src/NodeInterface.php NodeInterface
  6. 8.4.x core/modules/node/src/NodeInterface.php NodeInterface

Provides an interface defining a node entity.

Hierarchy

Expanded class hierarchy of NodeInterface

All classes that implement NodeInterface

56 files declare their use of NodeInterface
book.module in core/modules/book/book.module
Allows users to create and organize related content in an outline.
BookAdminEditForm.php in core/modules/book/src/Form/BookAdminEditForm.php
BookBreadcrumbBuilder.php in core/modules/book/src/BookBreadcrumbBuilder.php
BookController.php in core/modules/book/src/Controller/BookController.php
BookExport.php in core/modules/book/src/BookExport.php

... See full list

File

core/modules/node/src/NodeInterface.php, line 13

Namespace

Drupal\node
View source
interface NodeInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface, RevisionLogInterface {

  /**
   * Gets the node type.
   *
   * @return string
   *   The node type.
   */
  public function getType();

  /**
   * Gets the node title.
   *
   * @return string
   *   Title of the node.
   */
  public function getTitle();

  /**
   * Sets the node title.
   *
   * @param string $title
   *   The node title.
   *
   * @return \Drupal\node\NodeInterface
   *   The called node entity.
   */
  public function setTitle($title);

  /**
   * Gets the node creation timestamp.
   *
   * @return int
   *   Creation timestamp of the node.
   */
  public function getCreatedTime();

  /**
   * Sets the node creation timestamp.
   *
   * @param int $timestamp
   *   The node creation timestamp.
   *
   * @return \Drupal\node\NodeInterface
   *   The called node entity.
   */
  public function setCreatedTime($timestamp);

  /**
   * Returns the node promotion status.
   *
   * @return bool
   *   TRUE if the node is promoted.
   */
  public function isPromoted();

  /**
   * Sets the node promoted status.
   *
   * @param bool $promoted
   *   TRUE to set this node to promoted, FALSE to set it to not promoted.
   *
   * @return \Drupal\node\NodeInterface
   *   The called node entity.
   */
  public function setPromoted($promoted);

  /**
   * Returns the node sticky status.
   *
   * @return bool
   *   TRUE if the node is sticky.
   */
  public function isSticky();

  /**
   * Sets the node sticky status.
   *
   * @param bool $sticky
   *   TRUE to set this node to sticky, FALSE to set it to not sticky.
   *
   * @return \Drupal\node\NodeInterface
   *   The called node entity.
   */
  public function setSticky($sticky);

  /**
   * Returns the node published status indicator.
   *
   * Unpublished nodes are only visible to their authors and to administrators.
   *
   * @return bool
   *   TRUE if the node is published.
   */
  public function isPublished();

  /**
   * Sets the published status of a node..
   *
   * @param bool $published
   *   TRUE to set this node to published, FALSE to set it to unpublished.
   *
   * @return \Drupal\node\NodeInterface
   *   The called node entity.
   */
  public function setPublished($published);

  /**
   * Gets the node revision creation timestamp.
   *
   * @return int
   *   The UNIX timestamp of when this revision was created.
   */
  public function getRevisionCreationTime();

  /**
   * Sets the node revision creation timestamp.
   *
   * @param int $timestamp
   *   The UNIX timestamp of when this revision was created.
   *
   * @return \Drupal\node\NodeInterface
   *   The called node entity.
   */
  public function setRevisionCreationTime($timestamp);

  /**
   * Gets the node revision author.
   *
   * @return \Drupal\user\UserInterface
   *   The user entity for the revision author.
   *
   * @deprecated in Drupal 8.2.0, will be removed before Drupal 9.0.0. Use
   *   \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser() instead.
   */
  public function getRevisionAuthor();

  /**
   * Sets the node revision author.
   *
   * @param int $uid
   *   The user ID of the revision author.
   *
   * @return \Drupal\node\NodeInterface
   *   The called node entity.
   *
   * @deprecated in Drupal 8.2.0, will be removed before Drupal 9.0.0. Use
   *   \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId() instead.
   */
  public function setRevisionAuthorId($uid);

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. Overrides AccessibleInterface::access 6
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 31
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 31
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 25
ContentEntityInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. 1
ContentEntityInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. 1
ContentEntityInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected. 1
EntityChangedInterface::getChangedTime public function Gets the timestamp of the last entity change for the current translation. 1
EntityChangedInterface::getChangedTimeAcrossTranslations public function Gets the timestamp of the last entity change across all translations. 1
EntityChangedInterface::setChangedTime public function Sets the timestamp of the last entity change for the current translation. 1
EntityInterface::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 3
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 3
EntityInterface::createDuplicate public function Creates a duplicate of the entity. Overrides EntityInterface::createDuplicate 3
EntityInterface::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 3
EntityInterface::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew 3
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate 3
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey 3
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName 3
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget 3
EntityInterface::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType 3
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId 3
EntityInterface::getOriginalId public function Gets the original ID. Overrides EntityInterface::getOriginalId 3
EntityInterface::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData 3
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate 3
EntityInterface::id public function Gets the identifier. Overrides EntityInterface::id 3
EntityInterface::isNew public function Determines whether the entity is new. Overrides EntityInterface::isNew 3
EntityInterface::label public function Gets the label of the entity. Overrides EntityInterface::label 3
EntityInterface::language public function Gets the language of the entity. Overrides EntityInterface::language 3
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link 3
EntityInterface::load public static function Loads an entity. Overrides EntityInterface::load 3
EntityInterface::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple 3
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 3
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 3
EntityInterface::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 4
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 3
EntityInterface::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 3
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 3
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityInterface::preSave 3
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 3
EntityInterface::save public function Saves an entity permanently. Overrides EntityInterface::save 3
EntityInterface::setOriginalId public function Sets the original ID. Overrides EntityInterface::setOriginalId 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink 3
EntityInterface::toUrl public function Gets the URL object for the entity. Overrides EntityInterface::toUrl 3
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships 3
EntityInterface::url Deprecated public function Gets the public URL for this entity. Overrides EntityInterface::url 3
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. Overrides EntityInterface::urlInfo 3
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 3
EntityOwnerInterface::getOwner public function Returns the entity owner's user entity. 5
EntityOwnerInterface::getOwnerId public function Returns the entity owner's user ID. 5
EntityOwnerInterface::setOwner public function Sets the entity owner's user entity. 5
EntityOwnerInterface::setOwnerId public function Sets the entity owner's user ID. 5
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 2
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
FieldableEntityInterface::get public function Gets a field item list. 1
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field. 1
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields. 1
FieldableEntityInterface::getFields public function Gets an array of all field item lists. 1
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields. 1
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name. 1
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity. 1
FieldableEntityInterface::onChange public function Reacts to changes to a field. 1
FieldableEntityInterface::set public function Sets a field value. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity. 1
FieldableEntityInterface::toArray public function Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate public function Validates the currently set values. 1
NodeInterface::getCreatedTime public function Gets the node creation timestamp. 1
NodeInterface::getRevisionAuthor Deprecated public function Gets the node revision author. 1
NodeInterface::getRevisionCreationTime public function Gets the node revision creation timestamp. Overrides RevisionLogInterface::getRevisionCreationTime 1
NodeInterface::getTitle public function Gets the node title. 1
NodeInterface::getType public function Gets the node type. 1
NodeInterface::isPromoted public function Returns the node promotion status. 1
NodeInterface::isPublished public function Returns the node published status indicator. 1
NodeInterface::isSticky public function Returns the node sticky status. 1
NodeInterface::setCreatedTime public function Sets the node creation timestamp. 1
NodeInterface::setPromoted public function Sets the node promoted status. 1
NodeInterface::setPublished public function Sets the published status of a node.. 1
NodeInterface::setRevisionAuthorId Deprecated public function Sets the node revision author. 1
NodeInterface::setRevisionCreationTime public function Sets the node revision creation timestamp. Overrides RevisionLogInterface::setRevisionCreationTime 1
NodeInterface::setSticky public function Sets the node sticky status. 1
NodeInterface::setTitle public function Sets the node title. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency 3
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts 3
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags 3
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge 3
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity. 1
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision. 1
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save. 1
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved. 1
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 1
RevisionLogInterface::getRevisionLogMessage public function Returns the entity revision log message. 3
RevisionLogInterface::getRevisionUser public function Gets the entity revision author. 3
RevisionLogInterface::getRevisionUserId public function Gets the entity revision author ID. 3
RevisionLogInterface::setRevisionLogMessage public function Sets the entity revision log message. 3
RevisionLogInterface::setRevisionUser public function Sets the entity revision author. 3
RevisionLogInterface::setRevisionUserId public function Sets the entity revision author by ID. 3
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object. 1
TranslatableInterface::getTranslation public function Gets a translation of the data. 1
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 1
TranslatableInterface::getUntranslated public function Returns the translatable object referring to the original language. 1
TranslatableInterface::hasTranslation public function Returns TRUE there is a translation for the given language code. 1
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one. 1
TranslatableInterface::isNewTranslation public function Checks whether the translation is new. 1
TranslatableInterface::isTranslatable public function Returns the translation support status. 1
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code. 1