class DataType
Same name in this branch
- 10 core/lib/Drupal/Core/TypedData/Attribute/DataType.php \Drupal\Core\TypedData\Attribute\DataType
Same name in other branches
- 9 core/lib/Drupal/Core/TypedData/Annotation/DataType.php \Drupal\Core\TypedData\Annotation\DataType
- 8.9.x core/lib/Drupal/Core/TypedData/Annotation/DataType.php \Drupal\Core\TypedData\Annotation\DataType
- 11.x core/lib/Drupal/Core/TypedData/Attribute/DataType.php \Drupal\Core\TypedData\Attribute\DataType
- 11.x core/lib/Drupal/Core/TypedData/Annotation/DataType.php \Drupal\Core\TypedData\Annotation\DataType
Defines a data type annotation object.
The typed data API allows modules to support any kind of data based upon pre-defined primitive types and interfaces for complex data and lists.
Defined data types may map to one of the pre-defined primitive types below \Drupal\Core\TypedData\Type or may be complex data types, containing one or more data properties. Typed data objects for complex data types have to implement the \Drupal\Core\TypedData\ComplexDataInterface. Further interfaces that may be implemented are:
Furthermore, lists of data items are represented by objects implementing the \Drupal\Core\TypedData\ListInterface. A list contains items of the same data type, is ordered and may contain duplicates. The class used for a list of items of a certain type may be specified using the 'list class' key.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\Core\TypedData\Annotation\DataType extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of DataType
See also
\Drupal\Core\TypedData\TypedDataManager::create()
Related topics
1 file declares its use of DataType
- FieldType.php in core/
lib/ Drupal/ Core/ Field/ Annotation/ FieldType.php
File
-
core/
lib/ Drupal/ Core/ TypedData/ Annotation/ DataType.php, line 34
Namespace
Drupal\Core\TypedData\AnnotationView source
class DataType extends Plugin {
/**
* The data type plugin ID.
*
* @var string
*/
public $id;
/**
* The human-readable name of the data type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $label;
/**
* The description of the data type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $description;
/**
* The definition class to use for defining data of this type.
*
* Must implement the \Drupal\Core\TypedData\DataDefinitionInterface.
*
* @var string
*/
public $definition_class = '\\Drupal\\Core\\TypedData\\DataDefinition';
/**
* The typed data class used for wrapping multiple data items of the type.
*
* Must implement the \Drupal\Core\TypedData\ListInterface.
*
* @var string
*/
public $list_class = '\\Drupal\\Core\\TypedData\\Plugin\\DataType\\ItemList';
/**
* The definition class to use for defining a list of items of this type.
*
* Must implement the \Drupal\Core\TypedData\ListDataDefinitionInterface.
*
* @var string
*/
public $list_definition_class = '\\Drupal\\Core\\TypedData\\ListDataDefinition';
/**
* An array of validation constraints for this type.
*
* @var array
*
* @see \Drupal\Core\TypedData\TypedDataManager::getConstraints().
*/
public $constraints;
/**
* Whether the typed object wraps the canonical representation of the data.
*
* @var bool
*
* @see \Drupal\Core\TypedData\TypedDataManager::getCanonicalRepresentation()
*/
public $unwrap_for_canonical_representation = TRUE;
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DataType::$constraints | public | property | An array of validation constraints for this type. | ||
DataType::$definition_class | public | property | The definition class to use for defining data of this type. | ||
DataType::$description | public | property | The description of the data type. | 1 | |
DataType::$id | public | property | The data type plugin ID. | 1 | |
DataType::$label | public | property | The human-readable name of the data type. | 1 | |
DataType::$list_class | public | property | The typed data class used for wrapping multiple data items of the type. | 1 | |
DataType::$list_definition_class | public | property | The definition class to use for defining a list of items of this type. | ||
DataType::$unwrap_for_canonical_representation | public | property | Whether the typed object wraps the canonical representation of the data. | ||
Plugin::$definition | protected | property | The plugin definition read from the class annotation. | 1 | |
Plugin::get | public | function | Gets the value of an annotation. | Overrides AnnotationInterface::get | 6 |
Plugin::getClass | public | function | Gets the class of the annotated class. | Overrides AnnotationInterface::getClass | 1 |
Plugin::getId | public | function | Gets the unique ID for this annotated class. | Overrides AnnotationInterface::getId | |
Plugin::getProvider | public | function | Gets the name of the provider of the annotated class. | Overrides AnnotationInterface::getProvider | 1 |
Plugin::parse | protected | function | Parses an annotation into its definition. | ||
Plugin::setClass | public | function | Sets the class of the annotated class. | Overrides AnnotationInterface::setClass | 1 |
Plugin::setProvider | public | function | Sets the name of the provider of the annotated class. | Overrides AnnotationInterface::setProvider | |
Plugin::__construct | public | function | Constructs a Plugin object. | 3 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.