annotate core/modules/field/field.install @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /**
Chris@0 4 * @file
Chris@0 5 * Install, update and uninstall functions for the field module.
Chris@0 6 */
Chris@0 7
Chris@0 8 use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
Chris@14 9 use Drupal\field\Entity\FieldConfig;
Chris@14 10 use Drupal\field\Entity\FieldStorageConfig;
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Removes the stale 'target_bundle' storage setting on entity_reference fields.
Chris@0 14 */
Chris@0 15 function field_update_8001() {
Chris@0 16 $config = \Drupal::configFactory();
Chris@0 17 /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */
Chris@0 18 $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
Chris@0 19
Chris@0 20 // Iterate on all fields storage.
Chris@0 21 foreach ($config->listAll('field.storage.') as $field_id) {
Chris@0 22 $field_storage = $config->getEditable($field_id);
Chris@0 23 $class = $field_type_manager->getPluginClass($field_storage->get('type'));
Chris@0 24
Chris@0 25 // Deal only with entity reference fields and descendants.
Chris@0 26 if ($class == EntityReferenceItem::class || is_subclass_of($class, EntityReferenceItem::class)) {
Chris@0 27 // Remove 'target_bundle' from settings.
Chris@0 28 $field_storage->clear('settings.target_bundle')->save(TRUE);
Chris@0 29 }
Chris@0 30 }
Chris@0 31 }
Chris@0 32
Chris@0 33 /**
Chris@0 34 * The 'entity_reference' field type is now provided by core.
Chris@0 35 */
Chris@0 36 function field_update_8002() {
Chris@0 37 $config_factory = \Drupal::configFactory();
Chris@0 38
Chris@0 39 // Iterate on all configuration entities.
Chris@0 40 foreach ($config_factory->listAll() as $id) {
Chris@0 41 $changed = FALSE;
Chris@0 42 $config = $config_factory->getEditable($id);
Chris@0 43
Chris@0 44 // Update field storage configurations.
Chris@0 45 if (strpos($id, 'field.storage.') === 0) {
Chris@0 46 // Deal only with entity reference fields.
Chris@0 47 if ($config->get('type') == 'entity_reference') {
Chris@0 48 // Fix the type provider.
Chris@0 49 $config->set('module', 'core');
Chris@0 50 $changed = TRUE;
Chris@0 51 }
Chris@0 52 }
Chris@0 53
Chris@0 54 // Remove entity_reference module dependency from any configuration entity.
Chris@0 55 if ($dependencies = $config->get('dependencies.module')) {
Chris@0 56 if (($delta = array_search('entity_reference', $dependencies)) !== FALSE) {
Chris@0 57 unset($dependencies[$delta]);
Chris@0 58 if ($dependencies) {
Chris@0 59 $config->set('dependencies.module', array_values($dependencies));
Chris@0 60 }
Chris@0 61 else {
Chris@0 62 $config->clear('dependencies.module');
Chris@0 63 }
Chris@0 64 $changed = TRUE;
Chris@0 65 }
Chris@0 66 }
Chris@0 67
Chris@0 68 if ($changed) {
Chris@0 69 $config->save(TRUE);
Chris@0 70 }
Chris@0 71 }
Chris@0 72 }
Chris@0 73
Chris@0 74 /**
Chris@0 75 * Populate the new 'auto_create_bundle' setting for entity reference fields.
Chris@0 76 */
Chris@0 77 function field_update_8003() {
Chris@0 78 $config = \Drupal::configFactory();
Chris@0 79 /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */
Chris@0 80 $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
Chris@0 81
Chris@0 82 // Iterate over all fields.
Chris@0 83 foreach ($config->listAll('field.field.') as $field_id) {
Chris@0 84 $field = $config->getEditable($field_id);
Chris@0 85 $class = $field_type_manager->getPluginClass($field->get('field_type'));
Chris@0 86
Chris@0 87 // Deal only with entity reference fields and descendants.
Chris@0 88 if ($class == EntityReferenceItem::class || is_subclass_of($class, EntityReferenceItem::class)) {
Chris@0 89 $handler_settings = $field->get('settings.handler_settings');
Chris@0 90
Chris@0 91 if (is_array($handler_settings) && !empty($handler_settings['auto_create'])) {
Chris@0 92 // If the field can reference multiple bundles, pick the first one
Chris@0 93 // available in order to replicate the previous behavior.
Chris@0 94 if (is_array($handler_settings['target_bundles']) && count($handler_settings['target_bundles']) > 1) {
Chris@0 95 $handler_settings['auto_create_bundle'] = reset($handler_settings['target_bundles']);
Chris@0 96 }
Chris@0 97 // Otherwise, we don't know which bundle to use for auto-creation so we
Chris@0 98 // have to disable the functionality completely.
Chris@0 99 elseif (!$handler_settings['target_bundles']) {
Chris@0 100 $handler_settings['auto_create'] = FALSE;
Chris@0 101 $handler_settings['auto_create_bundle'] = NULL;
Chris@0 102 }
Chris@0 103 }
Chris@0 104
Chris@0 105 $field->set('settings.handler_settings', $handler_settings)->save(TRUE);
Chris@0 106 }
Chris@0 107 }
Chris@0 108 }
Chris@14 109
Chris@14 110 /**
Chris@14 111 * Update the definition of deleted fields.
Chris@14 112 */
Chris@14 113 function field_update_8500() {
Chris@14 114 $state = \Drupal::state();
Chris@14 115
Chris@14 116 // Convert the old deleted field definitions from an array to a FieldConfig
Chris@14 117 // object.
Chris@14 118 $deleted_field_definitions = $state->get('field.field.deleted', []);
Chris@14 119 foreach ($deleted_field_definitions as $key => $deleted_field_definition) {
Chris@14 120 if (is_array($deleted_field_definition)) {
Chris@14 121 $deleted_field_definitions[$key] = new FieldConfig($deleted_field_definition);
Chris@14 122 }
Chris@14 123 }
Chris@14 124 $state->set('field.field.deleted', $deleted_field_definitions);
Chris@14 125
Chris@14 126 // Convert the old deleted field storage definitions from an array to a
Chris@14 127 // FieldStorageConfig object.
Chris@14 128 $deleted_field_storage_definitions = $state->get('field.storage.deleted', []);
Chris@14 129 foreach ($deleted_field_storage_definitions as $key => $deleted_field_storage_definition) {
Chris@14 130 if (is_array($deleted_field_storage_definition)) {
Chris@14 131 $deleted_field_storage_definitions[$key] = new FieldStorageConfig($deleted_field_storage_definition);
Chris@14 132 }
Chris@14 133 }
Chris@14 134 $state->set('field.storage.deleted', $deleted_field_storage_definitions);
Chris@14 135 }