class DataReferenceDefinition

Same name in other branches
  1. 9 core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php \Drupal\Core\TypedData\DataReferenceDefinition
  2. 8.9.x core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php \Drupal\Core\TypedData\DataReferenceDefinition
  3. 10 core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php \Drupal\Core\TypedData\DataReferenceDefinition

A typed data definition class for defining references.

Note that this definition class assumes that the data type for referencing a certain target type is named "{TARGET_TYPE}_reference".

Hierarchy

Expanded class hierarchy of DataReferenceDefinition

See also

\Drupal\Core\TypedData\DataReferenceBase

6 files declare their use of DataReferenceDefinition
EntityReference.php in core/lib/Drupal/Core/Entity/Plugin/DataType/EntityReference.php
EntityReferenceItem.php in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.php
EntityTypedDataDefinitionTest.php in core/tests/Drupal/KernelTests/Core/Entity/EntityTypedDataDefinitionTest.php
LanguageItem.php in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.php
LanguageReference.php in core/lib/Drupal/Core/TypedData/Plugin/DataType/LanguageReference.php

... See full list

File

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

Namespace

Drupal\Core\TypedData
View source
class DataReferenceDefinition extends DataDefinition implements DataReferenceDefinitionInterface {
    
    /**
     * @var \Drupal\Core\TypedData\DataDefinitionInterface
     */
    protected $targetDefinition;
    
    /**
     * Creates a new data reference definition.
     *
     * @param string $target_data_type
     *   The data type of the referenced data.
     *
     * @return static
     */
    public static function create($target_data_type) {
        // This assumes implementations use a "TYPE_reference" naming pattern.
        $definition = parent::create($target_data_type . '_reference');
        return $definition->setTargetDefinition(\Drupal::typedDataManager()->createDataDefinition($target_data_type));
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createFromDataType($data_type) {
        if (!str_ends_with($data_type, '_reference')) {
            throw new \InvalidArgumentException('Data type must be of the form "{TARGET_TYPE}_reference"');
        }
        // Cut of the _reference suffix.
        return static::create(substr($data_type, 0, strlen($data_type) - strlen('_reference')));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTargetDefinition() {
        return $this->targetDefinition;
    }
    
    /**
     * Sets the definition of the referenced data.
     *
     * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
     *   The target definition to set.
     *
     * @return $this
     */
    public function setTargetDefinition(DataDefinitionInterface $definition) {
        $this->targetDefinition = $definition;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DataDefinition::$definition protected property The array holding values for all definition keys.
DataDefinition::addConstraint public function Adds a validation constraint. Overrides DataDefinitionInterface::addConstraint
DataDefinition::getClass public function Returns the class used for creating the typed data object. Overrides DataDefinitionInterface::getClass 1
DataDefinition::getConstraint public function Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints public function Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints 1
DataDefinition::getDataType public function Returns the data type of the data. Overrides DataDefinitionInterface::getDataType 2
DataDefinition::getDescription public function Returns a human readable description. Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel public function Returns a human readable label. Overrides DataDefinitionInterface::getLabel 1
DataDefinition::getSetting public function Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting 2
DataDefinition::getSettings public function Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings 2
DataDefinition::isComputed public function Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
DataDefinition::isInternal public function Determines whether the data value is internal. Overrides DataDefinitionInterface::isInternal 1
DataDefinition::isList public function Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface::isList
DataDefinition::isReadOnly public function Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired public function Determines whether a data value is required. Overrides DataDefinitionInterface::isRequired
DataDefinition::offsetExists public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetGet public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetSet public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetUnset public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::setClass public function Sets the class used for creating the typed data object.
DataDefinition::setComputed public function Sets whether the data is computed.
DataDefinition::setConstraints public function Sets an array of validation constraints.
DataDefinition::setDataType public function Sets the data type. 1
DataDefinition::setDescription public function Sets the human-readable description.
DataDefinition::setInternal public function Sets the whether the data value should be internal.
DataDefinition::setLabel public function Sets the human-readable label.
DataDefinition::setReadOnly public function Sets whether the data is read-only.
DataDefinition::setRequired public function Sets whether the data is required.
DataDefinition::setSetting public function Sets a definition setting. 2
DataDefinition::setSettings public function Sets the array of settings, as required by the used class. 2
DataDefinition::toArray public function Returns all definition values as array.
DataDefinition::__construct public function Constructs a new data definition object. 1
DataDefinition::__sleep public function 2
DataReferenceDefinition::$targetDefinition protected property
DataReferenceDefinition::create public static function Creates a new data reference definition. Overrides DataDefinition::create
DataReferenceDefinition::createFromDataType public static function Creates a new data definition object. Overrides DataDefinition::createFromDataType
DataReferenceDefinition::getTargetDefinition public function Gets the data definition of the referenced data. Overrides DataReferenceDefinitionInterface::getTargetDefinition
DataReferenceDefinition::setTargetDefinition public function Sets the definition of the referenced data.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2

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