interface ListDataDefinitionInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/TypedData/ListDataDefinitionInterface.php \Drupal\Core\TypedData\ListDataDefinitionInterface
Interface for data definitions of lists.
This interface is present on a data definition if it describes a list. The actual lists implement the \Drupal\Core\TypedData\ListInterface.
Hierarchy
- interface \Drupal\Core\TypedData\DataDefinitionInterface
- interface \Drupal\Core\TypedData\ListDataDefinitionInterface
Expanded class hierarchy of ListDataDefinitionInterface
All classes that implement ListDataDefinitionInterface
See also
\Drupal\Core\TypedData\ListDefinition
\Drupal\Core\TypedData\ListInterface
Related topics
3 files declare their use of ListDataDefinitionInterface
- EntityTypedDataDefinitionTest.php in core/
modules/ system/ src/ Tests/ Entity/ EntityTypedDataDefinitionTest.php - Contains \Drupal\system\Tests\Entity\EntityTypedDataDefinitionTest.
- FieldDefinitionInterface.php in core/
lib/ Drupal/ Core/ Field/ FieldDefinitionInterface.php - Contains \Drupal\Core\Field\FieldDefinitionInterface.
- TypedDataDefinitionTest.php in core/
modules/ system/ src/ Tests/ TypedData/ TypedDataDefinitionTest.php - Contains \Drupal\system\Tests\TypedData\TypedDataDefinitionTest.
File
- core/
lib/ Drupal/ Core/ TypedData/ ListDataDefinitionInterface.php, line 21 - Contains \Drupal\Core\TypedData\ListDataDefinitionInterface.
Namespace
Drupal\Core\TypedDataView source
interface ListDataDefinitionInterface extends DataDefinitionInterface {
/**
* Creates a new list data definition for items of the given data type.
*
* This method is typically used by
* \Drupal\Core\TypedData\TypedDataManager::createListDataDefinition() to
* build a definition object for an arbitrary item type. When the definition
* class is known, it is recommended to directly use the static create()
* method on that class instead; e.g.:
* @code
* $list_definition = \Drupal\Core\TypedData\ListDataDefinition::create('string');
* @endcode
*
* @param string $item_type
* The item type, for which a list data definition should be created.
*
* @return static
*
* @throws \InvalidArgumentException
* If an unsupported data type gets passed to the class; e.g., 'string' to a
* definition class handling lists of 'field_item:* data types.
*/
public static function createFromItemType($item_type);
/**
* Gets the data definition of an item of the list.
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface
* A data definition describing the list items.
*/
public function getItemDefinition();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 |
ListDataDefinitionInterface:: |
public static | function | Creates a new list data definition for items of the given data type. | 2 |
ListDataDefinitionInterface:: |
public | function | Gets the data definition of an item of the list. | 2 |