Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldType/UuidItem.php \Drupal\Core\Field\Plugin\Field\FieldType\UuidItem
- 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/UuidItem.php \Drupal\Core\Field\Plugin\Field\FieldType\UuidItem
Defines the 'uuid' entity field type.
The field uses a newly generated UUID as default value.
Plugin annotation
@FieldType(
id = "uuid",
label = @Translation("UUID"),
description = @Translation("An entity field containing a UUID."),
no_ui = TRUE,
default_formatter = "string"
)
Hierarchy
- class \Drupal\Core\Field\FieldItemBase extends \Drupal\Core\TypedData\Plugin\DataType\Map implements FieldItemInterface
- class \Drupal\Core\Field\Plugin\Field\FieldType\StringItemBase
- class \Drupal\Core\Field\Plugin\Field\FieldType\StringItem
- class \Drupal\Core\Field\Plugin\Field\FieldType\UuidItem
- class \Drupal\Core\Field\Plugin\Field\FieldType\StringItem
- class \Drupal\Core\Field\Plugin\Field\FieldType\StringItemBase
Expanded class hierarchy of UuidItem
File
- core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ UuidItem.php, line 21
Namespace
Drupal\Core\Field\Plugin\Field\FieldTypeView source
class UuidItem extends StringItem {
/**
* {@inheritdoc}
*/
public static function defaultStorageSettings() {
return [
'max_length' => 128,
'is_ascii' => TRUE,
] + parent::defaultStorageSettings();
}
/**
* {@inheritdoc}
*/
public function applyDefaultValue($notify = TRUE) {
// Default to one field item with a generated UUID.
$uuid = \Drupal::service('uuid');
$this
->setValue([
'value' => $uuid
->generate(),
], $notify);
return $this;
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) {
$schema = parent::schema($field_definition);
$schema['unique keys']['value'] = [
'value',
];
return $schema;
}
/**
* {@inheritdoc}
*/
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
$values['value'] = \Drupal::service('uuid')
->generate();
return $values;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComplexDataInterface:: |
public | function | Gets a property object. | |
ComplexDataInterface:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
ComplexDataInterface:: |
public | function | Gets an array of property objects. | 1 |
ComplexDataInterface:: |
public | function | Sets a property value. | 1 |
ComplexDataInterface:: |
public | function | Returns an array of all property values. | 1 |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items on the storage level. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Defines the field-level settings for this plugin. Overrides FieldItemInterface:: |
6 |
FieldItemBase:: |
public | function |
Defines custom delete behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom revision delete behavior for field values. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Returns a form for the field-level settings. Overrides FieldItemInterface:: |
6 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a short summary of the field's field-level settings. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Gets the entity that field belongs to. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the field definition. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the langcode of the field values held in the object. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function | Returns the value of a field setting. | |
FieldItemBase:: |
protected | function | Returns the array of field settings. | |
FieldItemBase:: |
public static | function |
Returns the name of the main property, if any. Overrides FieldItemInterface:: |
8 |
FieldItemBase:: |
public static | function |
Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemInterface:: |
6 |
FieldItemBase:: |
public | function |
Sets the data value. Overrides TypedDataInterface:: |
3 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a short summary of the field's storage-level settings. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Returns a renderable array for a single field item. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function | Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. | |
FieldItemBase:: |
public | function | 1 | |
FieldItemBase:: |
public | function |
Magic method: Gets a property value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Magic method: Determines whether a property is set. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Magic method: Sets a property value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Unsets a property. Overrides FieldItemInterface:: |
|
StringItem:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
|
StringItem:: |
public | function |
Returns a form for the storage-level settings. Overrides FieldItemBase:: |
|
StringItemBase:: |
public | function |
Determines whether the data structure is empty. Overrides ComplexDataInterface:: |
3 |
StringItemBase:: |
public static | function |
Defines field item properties. Overrides FieldItemInterface:: |
5 |
TraversableTypedDataInterface:: |
public | function | React to changes to a child property or item. | 5 |
TypedDataInterface:: |
public static | function | Constructs a TypedData object given its definition and context. | 1 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 1 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 1 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 1 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 1 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 1 |
TypedDataInterface:: |
public | function | Gets the data value. | 1 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 1 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 1 |
UuidItem:: |
public | function |
Applies the default value. Overrides TypedDataInterface:: |
|
UuidItem:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides StringItem:: |
|
UuidItem:: |
public static | function |
Generates placeholder field values. Overrides StringItem:: |
|
UuidItem:: |
public static | function |
Returns the schema for the field. Overrides StringItem:: |