function EntityBase::setOriginalId

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/EntityBase.php \Drupal\Core\Entity\EntityBase::setOriginalId()
  2. 10 core/lib/Drupal/Core/Entity/EntityBase.php \Drupal\Core\Entity\EntityBase::setOriginalId()
  3. 11.x core/lib/Drupal/Core/Entity/EntityBase.php \Drupal\Core\Entity\EntityBase::setOriginalId()

Sets the original ID.

Parameters

int|string|null $id: The new ID to set as original ID. If the entity supports renames, setting NULL will prevent an update from being considered a rename.

Return value

$this

Overrides EntityInterface::setOriginalId

1 method overrides EntityBase::setOriginalId()
ConfigEntityBase::setOriginalId in core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php
Sets the original ID.

File

core/lib/Drupal/Core/Entity/EntityBase.php, line 567

Class

EntityBase
Defines a base entity class.

Namespace

Drupal\Core\Entity

Code

public function setOriginalId($id) {
    // By default, entities do not support renames and do not have original IDs.
    // If the specified ID is anything except NULL, this should mark this entity
    // as no longer new.
    if ($id !== NULL) {
        $this->enforceIsNew(FALSE);
    }
    return $this;
}

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