public function DataDefinition::isInternal in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/TypedData/DataDefinition.php \Drupal\Core\TypedData\DataDefinition::isInternal()

Determines whether the data value is internal.

This can be used in a scenario when it is not desirable to expose this data value to an external system.

The implications of this method are left to the discretion of the caller. For example, a module providing an HTTP API may not expose entities of this type, or a custom entity reference field settings form may deprioritize entities of this type in a select list.

Return value

bool Whether the data value is internal.

Overrides DataDefinitionInterface::isInternal

1 method overrides DataDefinition::isInternal()

BaseFieldDefinition::isInternal in core/lib/Drupal/Core/Field/BaseFieldDefinition.php

Determines whether the data value is internal.

File

core/lib/Drupal/Core/TypedData/DataDefinition.php, line 365

Class

DataDefinition

A typed data definition class for defining data based on defined data types.

Namespace

Drupal\Core\TypedData

Code

public function isInternal() {

  // Respect the definition, otherwise default to TRUE for computed fields.
  if (isset($this->definition['internal'])) {
    return $this->definition['internal'];
  }
  return $this
    ->isComputed();
}