class DataReferenceDefinition in Zircon Profile 8.0
Same name and namespace in other branches
- 8 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
- class \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\ArrayAccess, DataDefinitionInterface
- class \Drupal\Core\TypedData\DataReferenceDefinition implements DataReferenceDefinitionInterface
Expanded class hierarchy of DataReferenceDefinition
See also
\Drupal\Core\TypedData\DataReferenceBase
4 files declare their use of DataReferenceDefinition
- EntityReferenceItem.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ EntityReferenceItem.php - Contains \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem.
- EntityTypedDataDefinitionTest.php in core/
modules/ system/ src/ Tests/ Entity/ EntityTypedDataDefinitionTest.php - Contains \Drupal\system\Tests\Entity\EntityTypedDataDefinitionTest.
- LanguageItem.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ LanguageItem.php - Contains \Drupal\Core\Field\Plugin\Field\FieldType\LanguageItem.
- TypedDataDefinitionTest.php in core/
modules/ system/ src/ Tests/ TypedData/ TypedDataDefinitionTest.php - Contains \Drupal\system\Tests\TypedData\TypedDataDefinitionTest.
File
- core/
lib/ Drupal/ Core/ TypedData/ DataReferenceDefinition.php, line 18 - Contains \Drupal\Core\TypedData\DataReferenceDefinition.
Namespace
Drupal\Core\TypedDataView 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 (substr($data_type, -strlen('_reference')) != '_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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DataDefinition:: |
protected | property | The array holding values for all definition keys. | |
DataDefinition:: |
public | function |
Adds a validation constraint. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns the class used for creating the typed data object. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Returns a validation constraint. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns an array of validation constraints. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Returns the data type of the data. Overrides DataDefinitionInterface:: |
2 |
DataDefinition:: |
public | function |
Returns a human readable description. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns a human readable label. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns the value of a given setting. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Determines whether the data value is computed. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Determines whether the data is read-only. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Determines whether a data value is required. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function | This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. | |
DataDefinition:: |
public | function | This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. | |
DataDefinition:: |
public | function | This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. | |
DataDefinition:: |
public | function | This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. | |
DataDefinition:: |
public | function | Sets the class used for creating the typed data object. | |
DataDefinition:: |
public | function | Sets whether the data is computed. | |
DataDefinition:: |
public | function | ||
DataDefinition:: |
public | function | Sets the data type. | 1 |
DataDefinition:: |
public | function | Sets the human-readable description. | |
DataDefinition:: |
public | function | Sets the human-readable label. | |
DataDefinition:: |
public | function | Sets whether the data is read-only. | |
DataDefinition:: |
public | function | Sets whether the data is required. | |
DataDefinition:: |
public | function | Sets a definition setting. | 1 |
DataDefinition:: |
public | function | Sets the array of settings, as required by the used class. | 1 |
DataDefinition:: |
public | function | Returns all definition values as array. | |
DataDefinition:: |
public | function | Constructs a new data definition object. | 1 |
DataReferenceDefinition:: |
protected | property | ||
DataReferenceDefinition:: |
public static | function |
Creates a new data reference definition. Overrides DataDefinition:: |
|
DataReferenceDefinition:: |
public static | function |
Creates a new data definition object. Overrides DataDefinition:: |
|
DataReferenceDefinition:: |
public | function |
Gets the data definition of the referenced data. Overrides DataReferenceDefinitionInterface:: |
|
DataReferenceDefinition:: |
public | function | Sets the definition of the referenced data. |