Same name in this branch
  1. 10 core/modules/node/src/Entity/Node.php \Drupal\node\Entity\Node
  2. 10 core/modules/node/src/Plugin/views/argument_default/Node.php \Drupal\node\Plugin\views\argument_default\Node
  3. 10 core/modules/node/src/Plugin/views/field/Node.php \Drupal\node\Plugin\views\field\Node
  4. 10 core/modules/node/src/Plugin/views/wizard/Node.php \Drupal\node\Plugin\views\wizard\Node
  5. 10 core/modules/node/src/Plugin/migrate/source/d6/Node.php \Drupal\node\Plugin\migrate\source\d6\Node
  6. 10 core/modules/node/src/Plugin/migrate/source/d7/Node.php \Drupal\node\Plugin\migrate\source\d7\Node
Same name and namespace in other branches
  1. 8.9.x core/modules/node/src/Entity/Node.php \Drupal\node\Entity\Node
  2. 9 core/modules/node/src/Entity/Node.php \Drupal\node\Entity\Node

Defines the node entity class.

Plugin annotation


@ContentEntityType(
  id = "node",
  label = @Translation("Content"),
  label_collection = @Translation("Content"),
  label_singular = @Translation("content item"),
  label_plural = @Translation("content items"),
  label_count = @PluralTranslation(
    singular = "@count content item",
    plural = "@count content items"
  ),
  bundle_label = @Translation("Content type"),
  handlers = {
    "storage" = "Drupal\node\NodeStorage",
    "storage_schema" = "Drupal\node\NodeStorageSchema",
    "view_builder" = "Drupal\node\NodeViewBuilder",
    "access" = "Drupal\node\NodeAccessControlHandler",
    "views_data" = "Drupal\node\NodeViewsData",
    "form" = {
      "default" = "Drupal\node\NodeForm",
      "delete" = "Drupal\node\Form\NodeDeleteForm",
      "edit" = "Drupal\node\NodeForm",
      "delete-multiple-confirm" = "Drupal\node\Form\DeleteMultiple"
    },
    "route_provider" = {
      "html" = "Drupal\node\Entity\NodeRouteProvider",
    },
    "list_builder" = "Drupal\node\NodeListBuilder",
    "translation" = "Drupal\node\NodeTranslationHandler"
  },
  base_table = "node",
  data_table = "node_field_data",
  revision_table = "node_revision",
  revision_data_table = "node_field_revision",
  show_revision_ui = TRUE,
  translatable = TRUE,
  list_cache_contexts = { "user.node_grants:view" },
  entity_keys = {
    "id" = "nid",
    "revision" = "vid",
    "bundle" = "type",
    "label" = "title",
    "langcode" = "langcode",
    "uuid" = "uuid",
    "status" = "status",
    "published" = "status",
    "uid" = "uid",
    "owner" = "uid",
  },
  revision_metadata_keys = {
    "revision_user" = "revision_uid",
    "revision_created" = "revision_timestamp",
    "revision_log_message" = "revision_log"
  },
  bundle_entity_type = "node_type",
  field_ui_base_route = "entity.node_type.edit_form",
  common_reference_target = TRUE,
  permission_granularity = "bundle",
  collection_permission = "access content overview",
  links = {
    "canonical" = "/node/{node}",
    "delete-form" = "/node/{node}/delete",
    "delete-multiple-form" = "/admin/content/node/delete",
    "edit-form" = "/node/{node}/edit",
    "version-history" = "/node/{node}/revisions",
    "revision" = "/node/{node}/revisions/{node_revision}/view",
    "create" = "/node",
  }
)

Hierarchy

Expanded class hierarchy of Node

182 files declare their use of Node
ArgumentDateTimeTest.php in core/modules/datetime/tests/src/Kernel/Views/ArgumentDateTimeTest.php
ArgumentDefaultTest.php in core/modules/views/tests/src/Functional/Plugin/ArgumentDefaultTest.php
ArgumentNodeRevisionIdTest.php in core/modules/node/tests/src/Kernel/Views/ArgumentNodeRevisionIdTest.php
ArgumentStringTest.php in core/modules/views/tests/src/Kernel/Handler/ArgumentStringTest.php
ArgumentUidRevisionTest.php in core/modules/node/tests/src/Kernel/Views/ArgumentUidRevisionTest.php

... See full list

25 string references to 'Node'
CategorizingPluginManagerTraitTest::setUp in core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php
CategorizingPluginManagerTraitTest::testProcessDefinitionCategory in core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php
@covers ::processDefinitionCategory
CategoryAutocompleteTest::providerTestAutocompleteSuggestions in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php
Data provider for testAutocompleteSuggestions().
CategoryAutocompleteTest::setUp in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php
CommentBundlesTest::setUp in core/modules/comment/tests/src/Kernel/CommentBundlesTest.php

... See full list

File

core/modules/node/src/Entity/Node.php, line 85

Namespace

Drupal\node\Entity
View source
class Node extends EditorialContentEntityBase implements NodeInterface {
  use EntityOwnerTrait;

  /**
   * Whether the node is being previewed or not.
   *
   * The variable is set to public as it will give a considerable performance
   * improvement. See https://www.drupal.org/node/2498919.
   *
   * @var true|null
   *   TRUE if the node is being previewed and NULL if it is not.
   */
  public $in_preview = NULL;

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    foreach (array_keys($this
      ->getTranslationLanguages()) as $langcode) {
      $translation = $this
        ->getTranslation($langcode);

      // If no owner has been set explicitly, make the anonymous user the owner.
      if (!$translation
        ->getOwner()) {
        $translation
          ->setOwnerId(0);
      }
    }

    // If no revision author has been set explicitly, make the node owner the
    // revision author.
    if (!$this
      ->getRevisionUser()) {
      $this
        ->setRevisionUserId($this
        ->getOwnerId());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preSaveRevision(EntityStorageInterface $storage, \stdClass $record) {
    parent::preSaveRevision($storage, $record);
    if (!$this
      ->isNewRevision() && isset($this->original) && (!isset($record->revision_log) || $record->revision_log === '')) {

      // If we are updating an existing node without adding a new revision, we
      // need to make sure $entity->revision_log is reset whenever it is empty.
      // Therefore, this code allows us to avoid clobbering an existing log
      // entry with an empty one.
      $record->revision_log = $this->original->revision_log->value;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);

    // Update the node access table for this node, but only if it is the
    // default revision. There's no need to delete existing records if the node
    // is new.
    if ($this
      ->isDefaultRevision()) {

      /** @var \Drupal\node\NodeAccessControlHandlerInterface $access_control_handler */
      $access_control_handler = \Drupal::entityTypeManager()
        ->getAccessControlHandler('node');
      $grants = $access_control_handler
        ->acquireGrants($this);
      \Drupal::service('node.grant_storage')
        ->write($this, $grants, NULL, $update);
    }

    // Reindex the node when it is updated. The node is automatically indexed
    // when it is added, simply by being added to the node table.
    if ($update) {
      node_reindex_node_search($this
        ->id());
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    parent::preDelete($storage, $entities);

    // Ensure that all nodes deleted are removed from the search index.
    if (\Drupal::hasService('search.index')) {

      /** @var \Drupal\search\SearchIndexInterface $search_index */
      $search_index = \Drupal::service('search.index');
      foreach ($entities as $entity) {
        $search_index
          ->clear('node_search', $entity->nid->value);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $nodes) {
    parent::postDelete($storage, $nodes);
    \Drupal::service('node.grant_storage')
      ->deleteNodeRecords(array_keys($nodes));
  }

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return $this
      ->bundle();
  }

  /**
   * {@inheritdoc}
   */
  public function access($operation = 'view', AccountInterface $account = NULL, $return_as_object = FALSE) {

    // This override exists to set the operation to the default value "view".
    return parent::access($operation, $account, $return_as_object);
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this
      ->get('title')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setTitle($title) {
    $this
      ->set('title', $title);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setCreatedTime($timestamp) {
    $this
      ->set('created', $timestamp);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isPromoted() {
    return (bool) $this
      ->get('promote')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setPromoted($promoted) {
    $this
      ->set('promote', $promoted ? NodeInterface::PROMOTED : NodeInterface::NOT_PROMOTED);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isSticky() {
    return (bool) $this
      ->get('sticky')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setSticky($sticky) {
    $this
      ->set('sticky', $sticky ? NodeInterface::STICKY : NodeInterface::NOT_STICKY);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields += static::ownerBaseFieldDefinitions($entity_type);
    $fields['title'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Title'))
      ->setRequired(TRUE)
      ->setTranslatable(TRUE)
      ->setRevisionable(TRUE)
      ->setSetting('max_length', 255)
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'string',
      'weight' => -5,
    ])
      ->setDisplayOptions('form', [
      'type' => 'string_textfield',
      'weight' => -5,
    ])
      ->setDisplayConfigurable('form', TRUE);
    $fields['uid']
      ->setLabel(t('Authored by'))
      ->setDescription(t('The username of the content author.'))
      ->setRevisionable(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'author',
      'weight' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'entity_reference_autocomplete',
      'weight' => 5,
      'settings' => [
        'match_operator' => 'CONTAINS',
        'size' => '60',
        'placeholder' => '',
      ],
    ])
      ->setDisplayConfigurable('form', TRUE);
    $fields['status']
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'settings' => [
        'display_label' => TRUE,
      ],
      'weight' => 120,
    ])
      ->setDisplayConfigurable('form', TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Authored on'))
      ->setDescription(t('The date and time that the content was created.'))
      ->setRevisionable(TRUE)
      ->setTranslatable(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'timestamp',
      'weight' => 0,
    ])
      ->setDisplayOptions('form', [
      'type' => 'datetime_timestamp',
      'weight' => 10,
    ])
      ->setDisplayConfigurable('form', TRUE);
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The time that the node was last edited.'))
      ->setRevisionable(TRUE)
      ->setTranslatable(TRUE);
    $fields['promote'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Promoted to front page'))
      ->setRevisionable(TRUE)
      ->setTranslatable(TRUE)
      ->setDefaultValue(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'settings' => [
        'display_label' => TRUE,
      ],
      'weight' => 15,
    ])
      ->setDisplayConfigurable('form', TRUE);
    $fields['sticky'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Sticky at top of lists'))
      ->setRevisionable(TRUE)
      ->setTranslatable(TRUE)
      ->setDefaultValue(FALSE)
      ->setDisplayOptions('form', [
      'type' => 'boolean_checkbox',
      'settings' => [
        'display_label' => TRUE,
      ],
      'weight' => 16,
    ])
      ->setDisplayConfigurable('form', TRUE);
    return $fields;
  }

}

Members

Namesort ascending Modifiers Type Description Overrides
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value.
TranslatableRevisionableInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected.
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced.
TranslatableRevisionableInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision.
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation.
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation.
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code.
TranslatableInterface::isTranslatable public function Returns the translation support status.
TranslatableInterface::isNewTranslation public function Checks whether the translation is new.
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one.
TranslatableInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes.
TranslatableInterface::hasTranslation public function Checks there is a translation for the given language code.
TranslatableInterface::getUntranslated public function Returns the translatable object in the language it was created.
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to.
TranslatableInterface::getTranslation public function Gets a translation of the data.
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object.
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag.
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization.
RevisionLogEntityTrait::setRevisionUserId public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().
RevisionLogEntityTrait::setRevisionUser public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().
RevisionLogEntityTrait::setRevisionLogMessage public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
RevisionLogEntityTrait::setRevisionCreationTime public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
RevisionLogEntityTrait::revisionLogBaseFieldDefinitions public static function Provides revision-related base field definitions for an entity type.
RevisionLogEntityTrait::getRevisionUserId public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().
RevisionLogEntityTrait::getRevisionUser public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().
RevisionLogEntityTrait::getRevisionLogMessage public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
RevisionLogEntityTrait::getRevisionCreationTime public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
RevisionLogEntityTrait::getEntityType abstract public function Gets the entity type definition.
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved.
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID.
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision.
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save.
RevisionableInterface::isLatestRevision public function Checks if this entity is the latest revision.
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision.
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity.
RevisionableInterface::getLoadedRevisionId public function Gets the loaded Revision ID of the entity.
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age.
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags.
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts.
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata.
NodeInterface::STICKY constant Denotes that the node is sticky at the top of the page.
NodeInterface::PUBLISHED constant Denotes that the node is published.
NodeInterface::PROMOTED constant Denotes that the node is promoted to the front page.
NodeInterface::NOT_STICKY constant Denotes that the node is not sticky at the top of the page.
NodeInterface::NOT_PUBLISHED constant Denotes that the node is not published.
NodeInterface::NOT_PROMOTED constant Denotes that the node is not promoted to the front page.
Node::setTitle public function Sets the node title. Overrides NodeInterface::setTitle
Node::setSticky public function Sets the node sticky status. Overrides NodeInterface::setSticky
Node::setPromoted public function Sets the node promoted status. Overrides NodeInterface::setPromoted
Node::setCreatedTime public function Sets the node creation timestamp. Overrides NodeInterface::setCreatedTime
Node::preSaveRevision public function Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision
Node::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityInterface::preSave
Node::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete
Node::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave
Node::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete
Node::isSticky public function Returns the node sticky status. Overrides NodeInterface::isSticky
Node::isPromoted public function Returns the node promotion status. Overrides NodeInterface::isPromoted
Node::getType public function Gets the node type. Overrides NodeInterface::getType
Node::getTitle public function Gets the node title. Overrides NodeInterface::getTitle
Node::getCreatedTime public function Gets the node creation timestamp. Overrides NodeInterface::getCreatedTime
Node::baseFieldDefinitions public static function Provides base field definitions for an entity type. Overrides EditorialContentEntityBase::baseFieldDefinitions
Node::access public function Checks data value access. Overrides AccessibleInterface::access
Node::$in_preview public property Whether the node is being previewed or not.
FieldableEntityInterface::validate public function Validates the currently set values. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity.
FieldableEntityInterface::set public function Sets a field value.
FieldableEntityInterface::onChange public function Reacts to changes to a field.
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity.
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name.
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields.
FieldableEntityInterface::getFields public function Gets an array of all field item lists.
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields.
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field.
FieldableEntityInterface::get public function Gets a field item list.
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
EntityPublishedTrait::setUnpublished public function
EntityPublishedTrait::setPublished public function
EntityPublishedTrait::publishedBaseFieldDefinitions public static function Returns an array of base field definitions for publishing status.
EntityPublishedTrait::isPublished public function
EntityOwnerTrait::setOwnerId public function
EntityOwnerTrait::setOwner public function
EntityOwnerTrait::ownerBaseFieldDefinitions public static function Returns an array of base field definitions for entity owners.
EntityOwnerTrait::getOwnerId public function
EntityOwnerTrait::getOwner public function 1
EntityOwnerTrait::getDefaultEntityOwner public static function Default value callback for 'owner' base field. 1
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 1
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 1
EntityInterface::toUrl public function Gets the URL object for the entity. 1
EntityInterface::toLink public function Generates the HTML for a link to this entity. 1
EntityInterface::toArray public function Gets an array of all property values. 2
EntityInterface::setOriginalId public function Sets the original ID. 1
EntityInterface::save public function Saves an entity permanently. 3
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 4
EntityInterface::postLoad public static function Acts on loaded entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 1
EntityInterface::loadMultiple public static function Loads one or more entities. 1
EntityInterface::load public static function Loads an entity. 1
EntityInterface::language public function Gets the language of the entity. 1
EntityInterface::label public function Gets the label of the entity. 3
EntityInterface::isNew public function Determines whether the entity is new. 1
EntityInterface::id public function Gets the identifier. 1
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 1
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 1
EntityInterface::getOriginalId public function Gets the original ID. 1
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 1
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 1
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 1
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 1
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 3
EntityInterface::enforceIsNew public function Enforces an entity to be new. 1
EntityInterface::delete public function Deletes an entity permanently. 1
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 1
EntityInterface::bundle public function Gets the bundle of the entity. 1
EntityChangedTrait::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations public function Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 12
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 19
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 19