interface ComplexDataDefinitionInterface in Zircon Profile 8.0
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/TypedData/ComplexDataDefinitionInterface.php \Drupal\Core\TypedData\ComplexDataDefinitionInterface
Interface for complex data definitions.
Hierarchy
- interface \Drupal\Core\TypedData\DataDefinitionInterface
- interface \Drupal\Core\TypedData\ComplexDataDefinitionInterface
Expanded class hierarchy of ComplexDataDefinitionInterface
All classes that implement ComplexDataDefinitionInterface
See also
\Drupal\Core\TypedData\ComplexDataInterface
Related topics
5 files declare their use of ComplexDataDefinitionInterface
- EntityDataDefinitionInterface.php in core/
lib/ Drupal/ Core/ Entity/ TypedData/ EntityDataDefinitionInterface.php - Contains \Drupal\Core\Entity\TypedData\EntityDataDefinitionInterface.
- EntityFieldTest.php in core/
modules/ system/ src/ Tests/ Entity/ EntityFieldTest.php - Contains \Drupal\system\Tests\Entity\EntityFieldTest.
- EntityTypedDataDefinitionTest.php in core/
modules/ system/ src/ Tests/ Entity/ EntityTypedDataDefinitionTest.php - Contains \Drupal\system\Tests\Entity\EntityTypedDataDefinitionTest.
- FieldItemDataDefinition.php in core/
lib/ Drupal/ Core/ Field/ TypedData/ FieldItemDataDefinition.php - Contains \Drupal\Core\Field\TypedData\FieldItemDataDefinition.
- TypedDataDefinitionTest.php in core/
modules/ system/ src/ Tests/ TypedData/ TypedDataDefinitionTest.php - Contains \Drupal\system\Tests\TypedData\TypedDataDefinitionTest.
File
- core/
lib/ Drupal/ Core/ TypedData/ ComplexDataDefinitionInterface.php, line 17 - Contains \Drupal\Core\TypedData\ComplexDataDefinitionInterface.
Namespace
Drupal\Core\TypedDataView source
interface ComplexDataDefinitionInterface extends DataDefinitionInterface {
/**
* Gets the definition of a contained property.
*
* @param string $name
* The name of property.
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface|null
* The definition of the property or NULL if the property does not exist.
*/
public function getPropertyDefinition($name);
/**
* Gets an array of property definitions of contained properties.
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*/
public function getPropertyDefinitions();
/**
* Returns the name of the main property, if any.
*
* Some field items consist mainly of one main property, e.g. the value of a
* text field or the @code target_id @endcode of an entity reference. If the
* field item has no main property, the method returns NULL.
*
* @return string|null
* The name of the value property, or NULL if there is none.
*/
public function getMainPropertyName();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComplexDataDefinitionInterface:: |
public | function | Returns the name of the main property, if any. | 2 |
ComplexDataDefinitionInterface:: |
public | function | Gets the definition of a contained property. | 2 |
ComplexDataDefinitionInterface:: |
public | function | Gets an array of property definitions of contained properties. | 2 |
DataDefinitionInterface:: |
public | function | Adds a validation constraint. | 2 |
DataDefinitionInterface:: |
public static | function | Creates a new data definition object. | 2 |
DataDefinitionInterface:: |
public | function | Returns the class used for creating the typed data object. | 2 |
DataDefinitionInterface:: |
public | function | Returns a validation constraint. | 2 |
DataDefinitionInterface:: |
public | function | Returns an array of validation constraints. | 2 |
DataDefinitionInterface:: |
public | function | Returns the data type of the data. | 2 |
DataDefinitionInterface:: |
public | function | Returns a human readable description. | 2 |
DataDefinitionInterface:: |
public | function | Returns a human readable label. | 2 |
DataDefinitionInterface:: |
public | function | Returns the value of a given setting. | 2 |
DataDefinitionInterface:: |
public | function | Returns the array of settings, as required by the used class. | 2 |
DataDefinitionInterface:: |
public | function | Determines whether the data value is computed. | 3 |
DataDefinitionInterface:: |
public | function | Returns whether the data is multi-valued, i.e. a list of data items. | 2 |
DataDefinitionInterface:: |
public | function | Determines whether the data is read-only. | 3 |
DataDefinitionInterface:: |
public | function | Determines whether a data value is required. | 2 |