ContentEntityBase::getEntityKey

protected ContentEntityBase::getEntityKey($key)

Gets the value of the given entity key, if defined.

Parameters

string $key: Name of the entity key, for example id, revision or bundle.

Return value

mixed The value of the entity key, NULL if not defined.

File

core/lib/Drupal/Core/Entity/ContentEntityBase.php, line 1088

Class

ContentEntityBase: Implements Entity Field API specific enhancements to the Entity class.

Namespace

Drupal\Core\Entity

Code

protected function getEntityKey($key) {
  // If the value is known already, return it.
  if (isset($this->entityKeys[$key])) {
    return $this->entityKeys[$key];
  }
  if (isset($this->translatableEntityKeys[$key][$this->activeLangcode])) {
    return $this->translatableEntityKeys[$key][$this->activeLangcode];
  }
 
  // Otherwise fetch the value by creating a field object.
  $value = NULL;
  if ($this->getEntityType()->hasKey($key)) {
    $field_name = $this->getEntityType()->getKey($key);
    $definition = $this->getFieldDefinition($field_name);
    $property = $definition->getFieldStorageDefinition()->getMainPropertyName();
    $value = $this->get($field_name)->$property;
 
    // Put it in the right array, depending on whether it is translatable.
    if ($definition->isTranslatable()) {
      $this->translatableEntityKeys[$key][$this->activeLangcode] = $value;
    }
    else {
      $this->entityKeys[$key] = $value;
    }
  }
  else {
    $this->entityKeys[$key] = $value;
  }
  return $value;
}

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21ContentEntityBase.php/function/ContentEntityBase%3A%3AgetEntityKey/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments