class EntityTestUpdate
Same name in other branches
- 9 core/modules/system/tests/modules/entity_test_update/src/Entity/EntityTestUpdate.php \Drupal\entity_test_update\Entity\EntityTestUpdate
- 8.9.x core/modules/system/tests/modules/entity_test_update/src/Entity/EntityTestUpdate.php \Drupal\entity_test_update\Entity\EntityTestUpdate
- 11.x core/modules/system/tests/modules/entity_test_update/src/Entity/EntityTestUpdate.php \Drupal\entity_test_update\Entity\EntityTestUpdate
Defines the test entity class for testing definition and schema updates.
This entity type starts out non-revisionable and non-translatable, but during an update test it can be made revisionable and translatable using the helper methods from \Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait.
Plugin annotation
@ContentEntityType(
id = "entity_test_update",
label = @Translation("Test entity update"),
handlers = {
"storage_schema" = "Drupal\entity_test_update\EntityTestUpdateStorageSchema",
"storage" = "Drupal\entity_test_update\EntityTestUpdateStorage",
},
base_table = "entity_test_update",
persistent_cache = FALSE,
entity_keys = {
"id" = "id",
"uuid" = "uuid",
"bundle" = "type",
"label" = "name",
"langcode" = "langcode",
},
content_translation_ui_skip = TRUE,
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
- class \Drupal\entity_test_update\Entity\EntityTestUpdate extends \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
Expanded class hierarchy of EntityTestUpdate
2 files declare their use of EntityTestUpdate
- EntityDefinitionUpdateTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Entity/ EntityDefinitionUpdateTest.php - MapBaseFieldTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Field/ MapBaseFieldTest.php
File
-
core/
modules/ system/ tests/ modules/ entity_test_update/ src/ Entity/ EntityTestUpdate.php, line 38
Namespace
Drupal\entity_test_update\EntityView source
class EntityTestUpdate extends ContentEntityBase {
/**
* {@inheritdoc}
*/
public static function preCreate(EntityStorageInterface $storage, array &$values) {
parent::preCreate($storage, $values);
if (empty($values['type'])) {
$values['type'] = $storage->getEntityTypeId();
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
// This entity type is used for generating database dumps from Drupal
// 8.0.0-rc1, which didn't have the entity key base fields defined in
// the parent class (ContentEntityBase), so we have to duplicate them here.
$fields[$entity_type->getKey('id')] = BaseFieldDefinition::create('integer')->setLabel(new TranslatableMarkup('ID'))
->setDescription(new TranslatableMarkup('The ID of the test entity.'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
$fields[$entity_type->getKey('uuid')] = BaseFieldDefinition::create('uuid')->setLabel(new TranslatableMarkup('UUID'))
->setDescription(new TranslatableMarkup('The UUID of the test entity.'))
->setReadOnly(TRUE);
$fields[$entity_type->getKey('bundle')] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Type'))
->setDescription(new TranslatableMarkup('The bundle of the test entity.'))
->setRequired(TRUE);
if ($entity_type->hasKey('revision')) {
$fields[$entity_type->getKey('revision')] = BaseFieldDefinition::create('integer')->setLabel(new TranslatableMarkup('Revision ID'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
}
$fields[$entity_type->getKey('langcode')] = BaseFieldDefinition::create('language')->setLabel(new TranslatableMarkup('Language'));
if ($entity_type->isRevisionable()) {
$fields[$entity_type->getKey('langcode')]
->setRevisionable(TRUE);
}
if ($entity_type->isTranslatable()) {
$fields[$entity_type->getKey('langcode')]
->setTranslatable(TRUE);
}
$fields['name'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Name'))
->setDescription(new TranslatableMarkup('The name of the test entity.'))
->setTranslatable(TRUE)
->setRevisionable(TRUE)
->setSetting('max_length', 32)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'string',
'weight' => -5,
])
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -5,
]);
$fields['test_single_property'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Field with a single property'))
->setTranslatable(TRUE)
->setRevisionable(TRUE);
$fields['test_multiple_properties'] = BaseFieldDefinition::create('multi_value_test')->setLabel(new TranslatableMarkup('Field with multiple properties'))
->setTranslatable(TRUE)
->setRevisionable(TRUE);
$fields['test_single_property_multiple_values'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Field with a single property and multiple values'))
->setCardinality(2)
->setTranslatable(TRUE)
->setRevisionable(TRUE);
$fields['test_multiple_properties_multiple_values'] = BaseFieldDefinition::create('multi_value_test')->setLabel(new TranslatableMarkup('Field with multiple properties and multiple values'))
->setCardinality(2)
->setTranslatable(TRUE)
->setRevisionable(TRUE);
$fields['test_non_rev_field'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Non Revisionable Field'))
->setDescription(new TranslatableMarkup('A non-revisionable test field.'))
->setCardinality(1)
->setRevisionable(FALSE)
->setTranslatable(TRUE);
$fields['test_non_mul_field'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Non Translatable Field'))
->setDescription(new TranslatableMarkup('A non-translatable test field.'))
->setCardinality(1)
->setRevisionable(TRUE)
->setTranslatable(FALSE);
$fields['test_non_mulrev_field'] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('Non Revisionable and Translatable Field'))
->setDescription(new TranslatableMarkup('A non-revisionable and non-translatable test field.'))
->setCardinality(1)
->setRevisionable(FALSE)
->setTranslatable(FALSE);
$fields += \Drupal::state()->get('entity_test_update.additional_base_field_definitions', []);
return $fields;
}
/**
* {@inheritdoc}
*/
public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
$fields = parent::bundleFieldDefinitions($entity_type, $bundle, $base_field_definitions);
$fields += \Drupal::state()->get('entity_test_update.additional_bundle_field_definitions.' . $bundle, []);
return $fields;
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.