abstract class ComplexDataDefinitionBase in Drupal 10
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php \Drupal\Core\TypedData\ComplexDataDefinitionBase
- 9 core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php \Drupal\Core\TypedData\ComplexDataDefinitionBase
Base class for complex data definitions.
Hierarchy
- class \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\ArrayAccess, DataDefinitionInterface uses TypedDataTrait
- class \Drupal\Core\TypedData\ComplexDataDefinitionBase implements ComplexDataDefinitionInterface
Expanded class hierarchy of ComplexDataDefinitionBase
1 file declares its use of ComplexDataDefinitionBase
- EntityDataDefinition.php in core/
lib/ Drupal/ Core/ Entity/ TypedData/ EntityDataDefinition.php
File
- core/
lib/ Drupal/ Core/ TypedData/ ComplexDataDefinitionBase.php, line 8
Namespace
Drupal\Core\TypedDataView source
abstract class ComplexDataDefinitionBase extends DataDefinition implements ComplexDataDefinitionInterface {
/**
* An array of data definitions.
*
* @var \Drupal\Core\TypedData\DataDefinitionInterface[]
*/
protected $propertyDefinitions;
/**
* {@inheritdoc}
*/
public abstract function getPropertyDefinitions();
/**
* {@inheritdoc}
*/
public function getPropertyDefinition($name) {
$definitions = $this
->getPropertyDefinitions();
if (isset($definitions[$name])) {
return $definitions[$name];
}
}
/**
* {@inheritdoc}
*/
public function getMainPropertyName() {
return NULL;
}
/**
* {@inheritdoc}
*/
public function __sleep() {
// Do not serialize the cached property definitions.
$vars = get_object_vars($this);
unset($vars['propertyDefinitions'], $vars['typedDataManager']);
return array_keys($vars);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComplexDataDefinitionBase:: |
protected | property | An array of data definitions. | |
ComplexDataDefinitionBase:: |
public | function |
Returns the name of the main property, if any. Overrides ComplexDataDefinitionInterface:: |
1 |
ComplexDataDefinitionBase:: |
public | function |
Gets the definition of a contained property. Overrides ComplexDataDefinitionInterface:: |
|
ComplexDataDefinitionBase:: |
abstract public | function |
Gets an array of property definitions of contained properties. Overrides ComplexDataDefinitionInterface:: |
2 |
ComplexDataDefinitionBase:: |
public | function |
Overrides DataDefinition:: |
|
DataDefinition:: |
protected | property | The array holding values for all definition keys. | |
DataDefinition:: |
public | function |
Adds a validation constraint. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public static | function | Creates a new data definition. | 5 |
DataDefinition:: |
public static | function |
Creates a new data definition object. Overrides DataDefinitionInterface:: |
5 |
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:: |
2 |
DataDefinition:: |
public | function |
Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface:: |
2 |
DataDefinition:: |
public | function |
Determines whether the data value is computed. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Determines whether the data value is internal. Overrides DataDefinitionInterface:: |
1 |
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 | ||
DataDefinition:: |
public | function | ||
DataDefinition:: |
public | function | ||
DataDefinition:: |
public | function | ||
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 | Sets an array of validation constraints. | |
DataDefinition:: |
public | function | Sets the data type. | 1 |
DataDefinition:: |
public | function | Sets the human-readable description. | |
DataDefinition:: |
public | function | Sets the whether the data value should be internal. | |
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. | 2 |
DataDefinition:: |
public | function | Sets the array of settings, as required by the used class. | 2 |
DataDefinition:: |
public | function | Returns all definition values as array. | |
DataDefinition:: |
public | function | Constructs a new data definition object. | 1 |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 1 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 1 |