function DataDefinitionInterface::isInternal

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php \Drupal\Core\TypedData\DataDefinitionInterface::isInternal()
  2. 8.9.x core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php \Drupal\Core\TypedData\DataDefinitionInterface::isInternal()
  3. 11.x core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php \Drupal\Core\TypedData\DataDefinitionInterface::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 reduce the priority for entities of this type in a select list.

Return value

bool Whether the data value is internal.

2 methods override DataDefinitionInterface::isInternal()
DataDefinition::isInternal in core/lib/Drupal/Core/TypedData/DataDefinition.php
Determines whether the data value is internal.
FieldConfigBase::isInternal in core/lib/Drupal/Core/Field/FieldConfigBase.php
Determines whether the data value is internal.

File

core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php, line 238

Class

DataDefinitionInterface
Interface for data definitions.

Namespace

Drupal\Core\TypedData

Code

public function isInternal();

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