interface NodeInterface

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

Provides an interface defining a node entity.

Hierarchy

  • interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable \Drupal\Core\Entity\FieldableEntityInterface \Drupal\Core\Entity\TranslatableRevisionableInterface \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityChangedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\EntityPublishedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\RevisionLogInterface extends \Drupal\Core\Entity\RevisionableInterface; interface \Drupal\user\EntityOwnerInterface
    • interface \Drupal\node\NodeInterface extends \Drupal\Core\Entity\ContentEntityInterface \Drupal\Core\Entity\EntityChangedInterface \Drupal\user\EntityOwnerInterface \Drupal\Core\Entity\RevisionLogInterface \Drupal\Core\Entity\EntityPublishedInterface

Expanded class hierarchy of NodeInterface

All classes that implement NodeInterface

90 files declare their use of NodeInterface
AggregatorTestBase.php in core/modules/aggregator/src/Tests/AggregatorTestBase.php
AggregatorTestBase.php in core/modules/aggregator/tests/src/Functional/AggregatorTestBase.php
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

... See full list

File

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

Namespace

Drupal\node
View source
interface NodeInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface, RevisionLogInterface, EntityPublishedInterface {
    
    /**
     * Denotes that the node is not published.
     */
    const NOT_PUBLISHED = 0;
    
    /**
     * Denotes that the node is published.
     */
    const PUBLISHED = 1;
    
    /**
     * Denotes that the node is not promoted to the front page.
     */
    const NOT_PROMOTED = 0;
    
    /**
     * Denotes that the node is promoted to the front page.
     */
    const PROMOTED = 1;
    
    /**
     * Denotes that the node is not sticky at the top of the page.
     */
    const NOT_STICKY = 0;
    
    /**
     * Denotes that the node is sticky at the top of the page.
     */
    const STICKY = 1;
    
    /**
     * 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 $this
     *   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 $this
     *   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 $this
     *   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 $this
     *   The called node entity.
     */
    public function setSticky($sticky);
    
    /**
     * 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 $this
     *   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 and is removed from drupal:9.0.0. Use
     *   \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser() instead.
     *
     * @see https://www.drupal.org/node/3069750
     */
    public function getRevisionAuthor();
    
    /**
     * Sets the node revision author.
     *
     * @param int $uid
     *   The user ID of the revision author.
     *
     * @return $this
     *   The called node entity.
     *
     * @deprecated in drupal:8.2.0 and is removed from drupal:9.0.0. Use
     *   \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId() instead.
     *
     * @see https://www.drupal.org/node/3069750
     */
    public function setRevisionAuthorId($uid);

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
EntityChangedInterface::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations public function Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
EntityOwnerInterface::getOwner public function Returns the entity owner's user entity. 1
EntityOwnerInterface::getOwnerId public function Returns the entity owner's user ID. 1
EntityOwnerInterface::setOwner public function Sets the entity owner's user entity. 1
EntityOwnerInterface::setOwnerId public function Sets the entity owner's user ID. 1
EntityPublishedInterface::isPublished public function Returns whether or not the entity is published.
EntityPublishedInterface::setPublished public function Sets the entity as published.
EntityPublishedInterface::setUnpublished public function Sets the entity as unpublished.
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
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::isSticky public function Returns the node sticky status. 1
NodeInterface::NOT_PROMOTED constant Denotes that the node is not promoted to the front page.
NodeInterface::NOT_PUBLISHED constant Denotes that the node is not published.
NodeInterface::NOT_STICKY constant Denotes that the node is not sticky at the top of the page.
NodeInterface::PROMOTED constant Denotes that the node is promoted to the front page.
NodeInterface::PUBLISHED constant Denotes that the node is published.
NodeInterface::setCreatedTime public function Sets the node creation timestamp. 1
NodeInterface::setPromoted public function Sets the node promoted status. 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
NodeInterface::setSticky public function Sets the node sticky status. 1
NodeInterface::setTitle public function Sets the node title. 1
NodeInterface::STICKY constant Denotes that the node is sticky at the top of the page.
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity.
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity.
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision.
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision.
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save.
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved.
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision.
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID.
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved.
RevisionLogInterface::getRevisionLogMessage public function Returns the entity revision log message.
RevisionLogInterface::getRevisionUser public function Gets the entity revision author.
RevisionLogInterface::getRevisionUserId public function Gets the entity revision author ID.
RevisionLogInterface::setRevisionLogMessage public function Sets the entity revision log message.
RevisionLogInterface::setRevisionUser public function Sets the entity revision author.
RevisionLogInterface::setRevisionUserId public function Sets the entity revision author by ID.

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