DataType.php
Same filename in this branch
Same filename in other branches
Namespace
Drupal\Core\TypedData\AnnotationFile
-
core/
lib/ Drupal/ Core/ TypedData/ Annotation/ DataType.php
View source
<?php
namespace Drupal\Core\TypedData\Annotation;
use Drupal\Component\Annotation\Plugin;
/**
* 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:
* - \Drupal\Core\Access\AccessibleInterface
* - \Drupal\Core\TypedData\TranslatableInterface
*
* 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.
*
* @see \Drupal::typedDataManager()
* @see \Drupal\Core\TypedData\TypedDataManager::create()
* @see hook_data_type_info_alter()
*
* @ingroup typed_data
*
* @Annotation
*/
class DataType extends Plugin {
/**
* The data type plugin ID.
*
* @var string
*/
public $id;
/**
* The human-readable name of the data type.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $label;
/**
* The description of the data type.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
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;
}
Classes
Title | Deprecated | Summary |
---|---|---|
DataType | Defines a data type annotation object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.