class TestItem
Same name and namespace in other branches
- 10 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php \Drupal\field_test\Plugin\Field\FieldType\TestItem
- 9 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php \Drupal\field_test\Plugin\Field\FieldType\TestItem
- 8.9.x core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php \Drupal\field_test\Plugin\Field\FieldType\TestItem
- main core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php \Drupal\field_test\Plugin\Field\FieldType\TestItem
Defines the 'test_field' entity field item.
Attributes
#[FieldType(id: "test_field", label: new TranslatableMarkup("Test field"), default_widget: "test_field_widget", default_formatter: "field_test_default")]
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ComplexDataInterface extends \Drupal\Core\TypedData\TypedData
- class \Drupal\Core\Field\FieldItemBase implements \Drupal\Core\Field\FieldItemInterface extends \Drupal\Core\TypedData\Plugin\DataType\Map
- class \Drupal\field_test\Plugin\Field\FieldType\TestItem extends \Drupal\Core\Field\FieldItemBase
- class \Drupal\Core\Field\FieldItemBase implements \Drupal\Core\Field\FieldItemInterface extends \Drupal\Core\TypedData\Plugin\DataType\Map
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ComplexDataInterface extends \Drupal\Core\TypedData\TypedData
Expanded class hierarchy of TestItem
File
-
core/
modules/ field/ tests/ modules/ field_test/ src/ Plugin/ Field/ FieldType/ TestItem.php, line 18
Namespace
Drupal\field_test\Plugin\Field\FieldTypeView source
class TestItem extends FieldItemBase {
/**
* {@inheritdoc}
*/
public static function defaultStorageSettings() {
return [
'test_field_storage_setting' => 'dummy test string',
'changeable' => 'a changeable field storage setting',
'unchangeable' => 'an unchangeable field storage setting',
'translatable_storage_setting' => 'a translatable field storage setting',
] + parent::defaultStorageSettings();
}
/**
* {@inheritdoc}
*/
public static function defaultFieldSettings() {
return [
'test_field_setting' => 'dummy test string',
'translatable_field_setting' => 'a translatable field setting',
] + parent::defaultFieldSettings();
}
/**
* {@inheritdoc}
*/
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
$properties['value'] = DataDefinition::create('integer')->setLabel(new TranslatableMarkup('Test integer value'))
->setRequired(TRUE);
return $properties;
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) {
return [
'columns' => [
'value' => [
'type' => 'int',
'size' => 'medium',
],
],
'indexes' => [
'value' => [
'value',
],
],
];
}
/**
* {@inheritdoc}
*/
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
$form['cardinality_container'][] = [
'#type' => 'html_tag',
'#tag' => 'p',
'#value' => 'Greetings from ' . __METHOD__,
];
$element = [];
$element['test_field_storage_setting'] = [
'#type' => 'textfield',
'#title' => $this->t('Field test field storage setting'),
'#default_value' => $this->getSetting('test_field_storage_setting'),
'#required' => FALSE,
'#description' => $this->t('A dummy form element to simulate field storage setting.'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
$element = [];
$element['test_field_setting'] = [
'#type' => 'textfield',
'#title' => $this->t('Field test field setting'),
'#default_value' => $this->getSetting('test_field_setting'),
'#required' => FALSE,
'#description' => $this->t('A dummy form element to simulate field setting.'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function delete() : void {
// Reports that delete() method is executed for testing purposes.
FieldTestHelper::memorize('field_test_field_delete', [
$this->getEntity(),
]);
}
/**
* {@inheritdoc}
*/
public function getConstraints() {
$constraint_manager = \Drupal::typedDataManager()->getValidationConstraintManager();
$constraints = parent::getConstraints();
$constraints[] = $constraint_manager->create('ComplexData', [
'properties' => [
'value' => [
'TestField' => [
'value' => -1,
'message' => $this->t('%name does not accept the value @value.', [
'%name' => $this->getFieldDefinition()
->getLabel(),
'@value' => -1,
]),
],
],
],
]);
return $constraints;
}
/**
* {@inheritdoc}
*/
public function isEmpty() {
return empty($this->value);
}
/**
* {@inheritdoc}
*/
public static function storageSettingsToConfigData(array $settings) {
$settings['config_data_from_storage_setting'] = 'TRUE';
unset($settings['storage_setting_from_config_data']);
return $settings;
}
/**
* {@inheritdoc}
*/
public static function storageSettingsFromConfigData(array $settings) {
$settings['storage_setting_from_config_data'] = 'TRUE';
unset($settings['config_data_from_storage_setting']);
return $settings;
}
/**
* {@inheritdoc}
*/
public static function fieldSettingsToConfigData(array $settings) {
$settings['config_data_from_field_setting'] = 'TRUE';
unset($settings['field_setting_from_config_data']);
return $settings;
}
/**
* {@inheritdoc}
*/
public static function fieldSettingsFromConfigData(array $settings) {
$settings['field_setting_from_config_data'] = 'TRUE';
unset($settings['config_data_from_field_setting']);
return $settings;
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||
| FieldItemBase::calculateDependencies | public static | function | Overrides FieldItemInterface::calculateDependencies | 3 | |
| FieldItemBase::calculateStorageDependencies | public static | function | Overrides FieldItemInterface::calculateStorageDependencies | 1 | |
| FieldItemBase::deleteRevision | public | function | Overrides FieldItemInterface::deleteRevision | ||
| FieldItemBase::fieldSettingsSummary | public static | function | Overrides FieldItemInterface::fieldSettingsSummary | 1 | |
| FieldItemBase::generateSampleValue | public static | function | Overrides FieldItemInterface::generateSampleValue | 18 | |
| FieldItemBase::getEntity | public | function | Overrides FieldItemInterface::getEntity | ||
| FieldItemBase::getFieldDefinition | public | function | Overrides FieldItemInterface::getFieldDefinition | ||
| FieldItemBase::getLangcode | public | function | Overrides FieldItemInterface::getLangcode | ||
| FieldItemBase::getSetting | protected | function | Returns the value of a field setting. | ||
| FieldItemBase::getSettings | protected | function | Returns the array of field settings. | ||
| FieldItemBase::mainPropertyName | public static | function | Overrides FieldItemInterface::mainPropertyName | 8 | |
| FieldItemBase::onDependencyRemoval | public static | function | Overrides FieldItemInterface::onDependencyRemoval | 1 | |
| FieldItemBase::postSave | public | function | Overrides FieldItemInterface::postSave | 2 | |
| FieldItemBase::preSave | public | function | Overrides FieldItemInterface::preSave | 7 | |
| FieldItemBase::setValue | public | function | Overrides Map::setValue | 4 | |
| FieldItemBase::storageSettingsSummary | public static | function | Overrides FieldItemInterface::storageSettingsSummary | 1 | |
| FieldItemBase::view | public | function | Overrides FieldItemInterface::view | ||
| FieldItemBase::writePropertyValue | 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. |
Overrides Map::writePropertyValue | |
| FieldItemBase::__construct | public | function | Overrides TypedData::__construct | 3 | |
| FieldItemBase::__get | public | function | Overrides FieldItemInterface::__get | 3 | |
| FieldItemBase::__isset | public | function | Overrides FieldItemInterface::__isset | ||
| FieldItemBase::__set | public | function | Overrides FieldItemInterface::__set | 1 | |
| FieldItemBase::__unset | public | function | Overrides FieldItemInterface::__unset | ||
| Map::$definition | protected | property | The data definition. | Overrides TypedData::$definition | |
| Map::$properties | protected | property | The array of properties. | ||
| Map::$values | protected | property | An array of values for the contained properties. | ||
| Map::applyDefaultValue | public | function | Overrides TypedData::applyDefaultValue | 4 | |
| Map::get | public | function | Overrides ComplexDataInterface::get | ||
| Map::getIterator | public | function | Retrieves the iterator for the object. | ||
| Map::getProperties | public | function | Overrides ComplexDataInterface::getProperties | ||
| Map::getString | public | function | Overrides TypedData::getString | ||
| Map::getValue | public | function | Overrides TypedData::getValue | 1 | |
| Map::onChange | public | function | Overrides TraversableTypedDataInterface::onChange | 5 | |
| Map::set | public | function | Overrides ComplexDataInterface::set | ||
| Map::toArray | public | function | Overrides ComplexDataInterface::toArray | 1 | |
| Map::__clone | public | function | Magic method: Implements a deep clone. | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | |
| TestItem::defaultFieldSettings | public static | function | Defines the field-level settings for this plugin. | Overrides FieldItemBase::defaultFieldSettings | |
| TestItem::defaultStorageSettings | public static | function | Defines the storage-level settings for this plugin. | Overrides FieldItemBase::defaultStorageSettings | |
| TestItem::delete | public | function | Defines custom delete behavior for field values. | Overrides FieldItemBase::delete | |
| TestItem::fieldSettingsForm | public | function | Returns a form for the field-level settings. | Overrides FieldItemBase::fieldSettingsForm | |
| TestItem::fieldSettingsFromConfigData | public static | function | Returns a settings array in the field type's canonical representation. | Overrides FieldItemBase::fieldSettingsFromConfigData | |
| TestItem::fieldSettingsToConfigData | public static | function | Returns a settings array that can be stored as a configuration value. | Overrides FieldItemBase::fieldSettingsToConfigData | |
| TestItem::getConstraints | public | function | Gets a list of validation constraints. | Overrides TypedData::getConstraints | |
| TestItem::isEmpty | public | function | Determines whether the data structure is empty. | Overrides Map::isEmpty | |
| TestItem::propertyDefinitions | public static | function | Defines field item properties. | Overrides FieldItemInterface::propertyDefinitions | |
| TestItem::schema | public static | function | Returns the schema for the field. | Overrides FieldItemInterface::schema | |
| TestItem::storageSettingsForm | public | function | Returns a form for the storage-level settings. | Overrides FieldItemBase::storageSettingsForm | |
| TestItem::storageSettingsFromConfigData | public static | function | Returns a settings array in the field type's canonical representation. | Overrides FieldItemBase::storageSettingsFromConfigData | |
| TestItem::storageSettingsToConfigData | public static | function | Returns a settings array that can be stored as a configuration value. | Overrides FieldItemBase::storageSettingsToConfigData | |
| TypedData::$name | protected | property | The property name. | ||
| TypedData::$parent | protected | property | The parent typed data object. | ||
| TypedData::createInstance | public static | function | Overrides TypedDataInterface::createInstance | ||
| TypedData::getDataDefinition | public | function | Overrides TypedDataInterface::getDataDefinition | ||
| TypedData::getName | public | function | Overrides TypedDataInterface::getName | ||
| TypedData::getParent | public | function | Overrides TypedDataInterface::getParent | ||
| TypedData::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | ||
| TypedData::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | ||
| TypedData::getPropertyPath | public | function | Overrides TypedDataInterface::getPropertyPath | ||
| TypedData::getRoot | public | function | Overrides TypedDataInterface::getRoot | ||
| TypedData::setContext | public | function | Overrides TypedDataInterface::setContext | ||
| TypedData::validate | public | function | Overrides TypedDataInterface::validate | ||
| TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | ||
| TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | |
| TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.