5 * Defines the 8400 db update for the "entity_rev_pub_updates" group.
8 use Drupal\Core\Field\BaseFieldDefinition;
11 * Implements hook_update_dependencies().
13 function entity_test_update_update_dependencies() {
14 // The update function that adds the status field must run after
15 // content_translation_update_8400() which fixes NULL values for the
16 // 'content_translation_status' field.
17 $dependencies['entity_test_update'][8400] = [
18 'content_translation' => 8400,
25 * Add the 'published' and revisionable metadata fields to entity_test_update.
27 function entity_test_update_update_8400() {
28 $definition_update_manager = \Drupal::entityDefinitionUpdateManager();
30 // Add the published entity key and revisionable metadata fields to the
31 // entity_test_update entity type.
32 $entity_type = $definition_update_manager->getEntityType('entity_test_update');
34 $entity_keys = $entity_type->getKeys();
35 $entity_keys['published'] = 'status';
36 $entity_type->set('entity_keys', $entity_keys);
38 $revision_metadata_keys = [
39 'revision_user' => 'revision_user',
40 'revision_created' => 'revision_created',
41 'revision_log_message' => 'revision_log_message'
43 $entity_type->set('revision_metadata_keys', $revision_metadata_keys);
45 $definition_update_manager->updateEntityType($entity_type);
47 // Add the status field.
48 $status = BaseFieldDefinition::create('boolean')
49 ->setLabel(t('Publishing status'))
50 ->setDescription(t('A boolean indicating the published state.'))
51 ->setRevisionable(TRUE)
52 ->setTranslatable(TRUE)
53 ->setDefaultValue(TRUE);
55 $has_content_translation_status_field = \Drupal::moduleHandler()->moduleExists('content_translation') && $definition_update_manager->getFieldStorageDefinition('content_translation_status', 'entity_test_update');
56 if ($has_content_translation_status_field) {
57 $status->setInitialValueFromField('content_translation_status');
60 $status->setInitialValue(TRUE);
62 $definition_update_manager->installFieldStorageDefinition('status', 'entity_test_update', 'entity_test_update', $status);
64 // Add the revision metadata fields.
65 $revision_created = BaseFieldDefinition::create('created')
66 ->setLabel(t('Revision create time'))
67 ->setDescription(t('The time that the current revision was created.'))
68 ->setRevisionable(TRUE);
69 $definition_update_manager->installFieldStorageDefinition('revision_created', 'entity_test_update', 'entity_test_update', $revision_created);
71 $revision_user = BaseFieldDefinition::create('entity_reference')
72 ->setLabel(t('Revision user'))
73 ->setDescription(t('The user ID of the author of the current revision.'))
74 ->setSetting('target_type', 'user')
75 ->setRevisionable(TRUE);
76 $definition_update_manager->installFieldStorageDefinition('revision_user', 'entity_test_update', 'entity_test_update', $revision_user);
78 $revision_log_message = BaseFieldDefinition::create('string_long')
79 ->setLabel(t('Revision log message'))
80 ->setDescription(t('Briefly describe the changes you have made.'))
81 ->setRevisionable(TRUE)
83 ->setDisplayOptions('form', [
84 'type' => 'string_textarea',
90 $definition_update_manager->installFieldStorageDefinition('revision_log_message', 'entity_test_update', 'entity_test_update', $revision_log_message);
92 // Uninstall the 'content_translation_status' field if needed.
93 $database = \Drupal::database();
94 if ($has_content_translation_status_field) {
95 // First we have to remove the field data.
96 $database->update($entity_type->getDataTable())
97 ->fields(['content_translation_status' => NULL])
100 // A site may have disabled revisionability for this entity type.
101 if ($entity_type->isRevisionable()) {
102 $database->update($entity_type->getRevisionDataTable())
103 ->fields(['content_translation_status' => NULL])
107 $content_translation_status = $definition_update_manager->getFieldStorageDefinition('content_translation_status', 'entity_test_update');
108 $definition_update_manager->uninstallFieldStorageDefinition($content_translation_status);