interface DataReferenceDefinitionInterface

Interface for typed data references.

Hierarchy

Expanded class hierarchy of DataReferenceDefinitionInterface

All classes that implement DataReferenceDefinitionInterface

See also

\Drupal\Core\TypedData\DataReferenceDefinition

\Drupal\Core\TypedData\DataReferenceInterface

Related topics

Typed Data API
API for describing data based on a set of available data types.
7 files declare their use of DataReferenceDefinitionInterface
EntityTypedDataDefinitionTest.php in core/tests/Drupal/KernelTests/Core/Entity/EntityTypedDataDefinitionTest.php
FieldResolver.php in core/modules/jsonapi/src/Context/FieldResolver.php
IncludeResolver.php in core/modules/jsonapi/src/IncludeResolver.php
ResourceIdentifier.php in core/modules/jsonapi/src/JsonApiResource/ResourceIdentifier.php
Tables.php in core/lib/Drupal/Core/Entity/Query/Sql/Tables.php

... See full list

File

View on git.drupalcode.org

core/lib/Drupal/Core/TypedData/DataReferenceDefinitionInterface.php, line 13

Namespace

Drupal\Core\TypedData
View source 
interface DataReferenceDefinitionInterface extends DataDefinitionInterface {
  
  /**
   * Gets the data definition of the referenced data.
   *
   * @return \Drupal\Core\TypedData\DataDefinitionInterface
   *   The data definition of the referenced data.
   */
  public function getTargetDefinition();

}

Members

Title Modifiers Object type Summary Overrides
DataDefinitionInterface::addConstraint public function Adds a validation constraint. 2
DataDefinitionInterface::createFromDataType public static function Creates a new data definition object. 2
DataDefinitionInterface::getClass public function Returns the class used for creating the typed data object. 2
DataDefinitionInterface::getConstraint public function Returns a validation constraint. 2
DataDefinitionInterface::getConstraints public function Returns an array of validation constraints. 2
DataDefinitionInterface::getDataType public function Returns the data type of the data. 2
DataDefinitionInterface::getDescription public function Returns a human readable description. 2
DataDefinitionInterface::getLabel public function Returns a human readable label. 2
DataDefinitionInterface::getSetting public function Returns the value of a given setting. 2
DataDefinitionInterface::getSettings public function Returns the array of settings, as required by the used class. 2
DataDefinitionInterface::isComputed public function Determines whether the data value is computed. 3
DataDefinitionInterface::isInternal public function Determines whether the data value is internal. 2
DataDefinitionInterface::isList public function Returns whether the data is multi-valued, i.e. a list of data items. 2
DataDefinitionInterface::isReadOnly public function Determines whether the data is read-only. 3
DataDefinitionInterface::isRequired public function Determines whether a data value is required. 2
DataReferenceDefinitionInterface::getTargetDefinition public function Gets the data definition of the referenced data. 1

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