class FieldType in Zircon Profile 8.0
Same name in this branch
- 8.0 core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
- 8.0 core/modules/field/src/Plugin/migrate/process/d6/FieldType.php \Drupal\field\Plugin\migrate\process\d6\FieldType
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Field/Annotation/FieldType.php \Drupal\Core\Field\Annotation\FieldType
Defines a FieldType annotation object.
Additional annotation keys for field types can be defined in hook_field_info_alter().
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
Expanded class hierarchy of FieldType
Related topics
36 classes are annotated with FieldType
- BooleanItem in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ BooleanItem.php - Defines the 'boolean' entity field type.
- ChangedItem in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ ChangedItem.php - Defines the 'changed' entity field type.
- ChangedTestItem in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ FieldType/ ChangedTestItem.php - Defines the 'changed_test' entity field type.
- CommentItem in core/
modules/ comment/ src/ Plugin/ Field/ FieldType/ CommentItem.php - Plugin implementation of the 'comment' field type.
- CreatedItem in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ CreatedItem.php - Defines the 'created' entity field type.
File
- core/
lib/ Drupal/ Core/ Field/ Annotation/ FieldType.php, line 22 - Contains \Drupal\Core\Field\Annotation\FieldType.
Namespace
Drupal\Core\Field\AnnotationView source
class FieldType extends DataType {
/**
* The plugin ID.
*
* @var string
*/
public $id;
/**
* The name of the module providing the field type plugin.
*
* @var string
*/
public $module;
/**
* The human-readable name of the field type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $label;
/**
* A short human readable description for the field type.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $description;
/**
* The category under which the field type should be listed in the UI.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $category = '';
/**
* The plugin_id of the default widget for this field type.
*
* This widget must be available whenever the field type is available (i.e.
* provided by the field type module, or by a module the field type module
* depends on).
*
* @var string
*/
public $default_widget;
/**
* The plugin_id of the default formatter for this field type.
*
* This formatter must be available whenever the field type is available (i.e.
* provided by the field type module, or by a module the field type module
* depends on).
*
* @var string
*/
public $default_formatter;
/**
* A boolean stating that fields of this type cannot be created through the UI.
*
* @var bool
*/
public $no_ui = FALSE;
/**
* {@inheritdoc}
*/
public $list_class;
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DataType:: |
public | property | An array of validation constraints for this type. | |
DataType:: |
public | property | The definition class to use for defining data of this type. Must implement the \Drupal\Core\TypedData\DataDefinitionInterface. | |
DataType:: |
public | property | The definition class to use for defining a list of items of this type. Must implement the \Drupal\Core\TypedData\ListDataDefinitionInterface. | |
DataType:: |
public | property | The pre-defined primitive type that this data type maps to. | |
DataType:: |
public | property | Whether the typed object wraps the canonical representation of the data. | |
FieldType:: |
public | property | The category under which the field type should be listed in the UI. | |
FieldType:: |
public | property | The plugin_id of the default formatter for this field type. | |
FieldType:: |
public | property | The plugin_id of the default widget for this field type. | |
FieldType:: |
public | property |
A short human readable description for the field type. Overrides DataType:: |
|
FieldType:: |
public | property |
The plugin ID. Overrides DataType:: |
|
FieldType:: |
public | property |
The human-readable name of the field type. Overrides DataType:: |
|
FieldType:: |
public | property |
The typed data class used for wrapping multiple data items of the type.
Must implement the \Drupal\Core\TypedData\ListInterface. Overrides DataType:: |
|
FieldType:: |
public | property | The name of the module providing the field type plugin. | |
FieldType:: |
public | property | A boolean stating that fields of this type cannot be created through the UI. | |
Plugin:: |
protected | property | The plugin definition read from the class annotation. | 1 |
Plugin:: |
public | function |
Gets the value of an annotation. Overrides AnnotationInterface:: |
2 |
Plugin:: |
public | function |
Gets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the unique ID for this annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
protected | function | Parses an annotation into its definition. | |
Plugin:: |
public | function |
Sets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Sets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function | Constructs a Plugin object. | 1 |