Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.php \Drupal\Core\Field\Plugin\Field\FieldType\StringItem
- 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.php \Drupal\Core\Field\Plugin\Field\FieldType\StringItem
Defines the 'string' entity field type.
Plugin annotation
@FieldType(
id = "string",
label = @Translation("Text (plain)"),
description = {
@Translation("Ideal for titles and names"),
@Translation("Efficient storage for short text"),
@Translation("Requires specifying a maximum length"),
@Translation("Good for fields with known or predictable length"),
},
category = "plain_text",
default_widget = "string_textfield",
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\StringItemBase
Expanded class hierarchy of StringItem
6 files declare their use of StringItem
- ComputedTestCacheableStringItem.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ FieldType/ ComputedTestCacheableStringItem.php - InternalPropertyTestFieldItem.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ FieldType/ InternalPropertyTestFieldItem.php - SingleInternalPropertyTestFieldItem.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ FieldType/ SingleInternalPropertyTestFieldItem.php - StringItemTest.php in core/
tests/ Drupal/ Tests/ Core/ Field/ StringItemTest.php - TimeZoneItem.php in core/
modules/ user/ src/ TimeZoneItem.php
File
- core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ StringItem.php, line 27
Namespace
Drupal\Core\Field\Plugin\Field\FieldTypeView source
class StringItem extends StringItemBase {
/**
* {@inheritdoc}
*/
public static function defaultStorageSettings() {
return [
'max_length' => 255,
'is_ascii' => FALSE,
] + parent::defaultStorageSettings();
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) {
return [
'columns' => [
'value' => [
'type' => $field_definition
->getSetting('is_ascii') === TRUE ? 'varchar_ascii' : 'varchar',
'length' => (int) $field_definition
->getSetting('max_length'),
'binary' => $field_definition
->getSetting('case_sensitive'),
],
],
];
}
/**
* {@inheritdoc}
*/
public function getConstraints() {
$constraints = parent::getConstraints();
if ($max_length = $this
->getSetting('max_length')) {
$constraint_manager = \Drupal::typedDataManager()
->getValidationConstraintManager();
$constraints[] = $constraint_manager
->create('ComplexData', [
'value' => [
'Length' => [
'max' => $max_length,
'maxMessage' => $this
->t('%name: may not be longer than @max characters.', [
'%name' => $this
->getFieldDefinition()
->getLabel(),
'@max' => $max_length,
]),
],
],
]);
}
return $constraints;
}
/**
* {@inheritdoc}
*/
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
$random = new Random();
$max_length = $field_definition
->getSetting('max_length');
// When the maximum length is less than 15, or the field needs to be unique,
// generate a random word using the maximum length.
if ($max_length <= 15 || $field_definition
->getConstraint('UniqueField')) {
$values['value'] = ucfirst($random
->word($max_length));
return $values;
}
// The minimum length is either 10% of the maximum length, or 15 characters
// long, whichever is greater.
$min_length = max(ceil($max_length * 0.1), 15);
// Reduce the max length to allow us to add a period.
$max_length -= 1;
// The random value is generated multiple times to create a slight
// preference towards values that are closer to the minimum length of the
// string. For values larger than 255 (which is the default maximum value),
// the bias towards minimum length is increased. This is because the default
// maximum length of 255 is often used for fields that include shorter
// values (i.e. title).
$length = mt_rand($min_length, mt_rand($min_length, $max_length >= 255 ? mt_rand($min_length, $max_length) : $max_length));
$string = $random
->sentences(1);
while (mb_strlen($string) < $length) {
$string .= " {$random->sentences(1)}";
}
if (mb_strlen($string) > $max_length) {
$string = substr($string, 0, $length);
$string = substr($string, 0, strrpos($string, ' '));
}
$string = rtrim($string, ' .');
// Ensure that the string ends with a full stop if there are multiple
// sentences.
$values['value'] = $string . (str_contains($string, '.') ? '.' : '');
return $values;
}
/**
* {@inheritdoc}
*/
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
$element = [];
$element['max_length'] = [
'#type' => 'number',
'#title' => $this
->t('Maximum length'),
'#default_value' => $this
->getSetting('max_length'),
'#required' => TRUE,
'#description' => $this
->t('The maximum length of the field in characters.'),
'#min' => 1,
'#disabled' => $has_data,
];
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
StringItem:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides StringItemBase:: |
2 |
StringItem:: |
public static | function |
Returns the schema for the field. Overrides FieldItemInterface:: |
2 |
StringItem:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
|
StringItem:: |
public static | function |
Generates placeholder field values. Overrides FieldItemBase:: |
4 |
StringItem:: |
public | function |
Returns a form for the storage-level settings. Overrides FieldItemBase:: |
|
StringItemBase:: |
public static | function |
Defines field item properties. Overrides FieldItemInterface:: |
5 |
StringItemBase:: |
public | function |
Determines whether the data structure is empty. Overrides ComplexDataInterface:: |
3 |
FieldItemBase:: |
public static | function |
Defines the field-level settings for this plugin. Overrides FieldItemInterface:: |
6 |
FieldItemBase:: |
public static | function |
Returns the name of the main property, if any. Overrides FieldItemInterface:: |
8 |
FieldItemBase:: |
public | function | 2 | |
FieldItemBase:: |
public | function |
Gets the entity that field belongs to. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the langcode of the field values held in the object. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the field definition. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function | Returns the array of field settings. | |
FieldItemBase:: |
protected | function | Returns the value of a field setting. | |
FieldItemBase:: |
public | function |
Sets the data value. Overrides TypedDataInterface:: |
3 |
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 |
Magic method: Gets a property value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Magic method: Sets a property value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Determines whether a property is set. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Magic method: Unsets a property. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Returns a renderable array for a single field item. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemInterface:: |
6 |
FieldItemBase:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemInterface:: |
2 |
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 that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
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 |
Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a short summary of the field's storage-level settings. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a short summary of the field's field-level settings. Overrides FieldItemInterface:: |
|
ComplexDataInterface:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
ComplexDataInterface:: |
public | function | Gets a property object. | |
ComplexDataInterface:: |
public | function | Sets a property value. | 1 |
ComplexDataInterface:: |
public | function | Gets an array of property objects. | 1 |
ComplexDataInterface:: |
public | function | Returns an array of all property values. | 1 |
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 | Gets the data value. | 1 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 1 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 1 |
TypedDataInterface:: |
public | function | Applies the default value. | 6 |
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 root of the typed data tree. | 1 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 1 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 1 |