field.module 13.1 KB
Newer Older
1 2 3
<?php
/**
 * @file
4
 * Attach custom data fields to Drupal entities.
5 6
 */

7
use Drupal\Core\Config\ConfigImporter;
8
use Drupal\Core\Entity\EntityTypeInterface;
9
use Drupal\Core\Entity\DynamicallyFieldableEntityStorageInterface;
10
use Drupal\Core\Extension\Extension;
11
use Drupal\field\Entity\FieldConfig;
12
use Drupal\Core\Form\FormStateInterface;
13
use Drupal\Core\Routing\RouteMatchInterface;
14
use Drupal\Core\Url;
15

16
/*
17 18 19
 * Load all public Field API functions. Drupal currently has no
 * mechanism for auto-loading core APIs, so we have to load them on
 * every page request.
20
 */
21
require_once __DIR__ . '/field.purge.inc';
22

23 24 25
/**
 * @defgroup field Field API
 * @{
26 27 28 29 30 31 32 33
 * Attaches custom data fields to Drupal entities.
 *
 * The Field API allows custom data fields to be attached to Drupal entities and
 * takes care of storing, loading, editing, and rendering field data. Any entity
 * type (node, user, etc.) can use the Field API to make itself "fieldable" and
 * thus allow fields to be attached to it. Other modules can provide a user
 * interface for managing custom fields via a web browser as well as a wide and
 * flexible variety of data type, form element, and display format capabilities.
34
 *
35 36 37
 * The Field API defines two primary data structures, FieldStorage and Field,
 * and the concept of a Bundle. A FieldStorage defines a particular type of data
 * that can be attached to entities. A Field is attached to a single
38 39 40 41 42 43 44 45 46
 * Bundle. A Bundle is a set of fields that are treated as a group by the Field
 * Attach API and is related to a single fieldable entity type.
 *
 * For example, suppose a site administrator wants Article nodes to have a
 * subtitle and photo. Using the Field API or Field UI module, the administrator
 * creates a field named 'subtitle' of type 'text' and a field named 'photo' of
 * type 'image'. The administrator (again, via a UI) creates two Field
 * Instances, one attaching the field 'subtitle' to the 'node' bundle 'article'
 * and one attaching the field 'photo' to the 'node' bundle 'article'. When the
47
 * node storage loads an Article node, it loads the values of the
48 49
 * 'subtitle' and 'photo' fields because they are both attached to the 'node'
 * bundle 'article'.
50
 *
51 52 53 54 55 56
 * - @link field_types Field Types API @endlink: Defines field types, widget
 *   types, and display formatters. Field modules use this API to provide field
 *   types like Text and Node Reference along with the associated form elements
 *   and display formatters.
 *
 * - @link field_purge Field API bulk data deletion @endlink: Cleans up after
57
 *   bulk deletion operations such as deletion of field storage or field.
58 59 60
 */

/**
61
 * Implements hook_help().
62
 */
63
function field_help($route_name, RouteMatchInterface $route_match) {
64 65
  switch ($route_name) {
    case 'help.page.field':
66 67
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
68
      $output .= '<p>' . t('The Field module allows custom data fields to be defined for <a href="!entity-help"><em>entity</em></a> types (entities include content items, comments, user accounts, and taxonomy terms). The Field module takes care of storing, loading, editing, and rendering field data. Most users will not interact with the Field module directly, but will instead use the <a href="!field-ui-help">Field UI module</a> user interface. Module developers can use the Field API to make new entity types "fieldable" and thus allow fields to be attached to them. For more information, see the <a href="!field">online documentation for the Field module</a>.', array('!entity-help' => \Drupal::url('help.page', array('name' => 'entity')), '!field-ui-help' => \Drupal::url('help.page', array('name' => 'field_ui')), '!field' => 'https://drupal.org/documentation/modules/field')) . '</p>';
69 70 71
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
72
      $output .= '<dd>' . t('The Field module provides the infrastructure for fields and field attachment; the field types and input widgets themselves are provided by additional modules. Some of the modules are required; the optional modules can be enabled from the <a href="!modules">Extend administration page</a>. Additional fields and widgets may be provided by contributed modules, which you can find in the <a href="!contrib">contributed module section of Drupal.org</a>.', array('!modules' => \Drupal::url('system.modules_list'), '!contrib' => 'https://drupal.org/project/modules'));
73

74 75
      // Make a list of all widget and field modules currently enabled, ordered
      // by displayed module name (module names are not translated).
76 77
      $items = array();
      $info = system_get_info('module');
78
      $field_widgets = \Drupal::service('plugin.manager.field.widget')->getDefinitions();
79
      $field_types = \Drupal::service('plugin.manager.field.field_type')->getUiDefinitions();
80
      $providers = array();
81 82
      foreach (array_merge($field_types, $field_widgets) as $plugin) {
        $providers[] = $plugin['provider'];
83
      }
84 85 86 87 88 89 90 91
      $providers = array_unique($providers);
      sort($providers);
      foreach ($providers as $provider) {
        // Skip plugins provided by core components as they do not implement
        // hook_help().
        if (isset($info[$provider]['name'])) {
          $display = $info[$provider]['name'];
          if (\Drupal::moduleHandler()->implementsHook($provider, 'help')) {
92
            $items[] = \Drupal::l($display, new Url('help.page', array('name' => $provider)));
93 94 95 96
          }
          else {
            $items[] = $display;
          }
97 98
        }
      }
99 100 101 102 103 104 105 106
      if ($items) {
        $output .= ' ' . t('Currently enabled field and input widget modules:');
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $items,
        );
        $output .= drupal_render($item_list);
      }
107 108 109 110
      return $output;
  }
}

111
/**
112
 * Implements hook_cron().
113 114
 */
function field_cron() {
115
  // Do a pass of purging on deleted Field API data, if any exists.
116
  $limit = \Drupal::config('field.settings')->get('purge_batch_size');
117 118 119
  field_purge_batch($limit);
}

120
/**
121 122
 * Implements hook_system_info_alter().
 *
123
 * Goes through a list of all modules that provide a field type and makes them
124
 * required if there are any active fields of that type.
125
 */
126
function field_system_info_alter(&$info, Extension $file, $type) {
127 128
  // It is not safe to call entity_load_multiple_by_properties() during
  // maintenance mode.
129
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
130 131
    $field_storages = entity_load_multiple_by_properties('field_storage_config', array('module' => $file->getName(), 'include_deleted' => TRUE));
    if ($field_storages) {
132 133 134 135 136
      $info['required'] = TRUE;

      // Provide an explanation message (only mention pending deletions if there
      // remains no actual, non-deleted fields)
      $non_deleted = FALSE;
137 138
      foreach ($field_storages as $field_storage) {
        if (empty($field_storage->deleted)) {
139 140 141 142 143
          $non_deleted = TRUE;
          break;
        }
      }
      if ($non_deleted) {
144
        $explanation = t('Fields type(s) in use');
145 146 147 148 149 150
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
151 152 153
  }
}

154 155 156 157
/**
 * Implements hook_entity_field_storage_info().
 */
function field_entity_field_storage_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type) {
158
  if (\Drupal::entityManager()->getStorage($entity_type->id()) instanceof DynamicallyFieldableEntityStorageInterface) {
159 160
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
161
    $ids = \Drupal::entityQuery('field_storage_config')
162 163 164
      ->condition('id', $entity_type->id() . '.', 'STARTS_WITH')
      ->execute();
    // Fetch all fields and key them by field name.
165
    $field_storages = entity_load_multiple('field_storage_config', $ids);
166
    $result = array();
167 168
    foreach ($field_storages as $field_storage) {
      $result[$field_storage->getName()] = $field_storage;
169
    }
170

171 172 173 174
    return $result;
  }
}

175
/**
176
 * Implements hook_entity_bundle_field_info().
177
 */
178
function field_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
179
  if (\Drupal::entityManager()->getStorage($entity_type->id()) instanceof DynamicallyFieldableEntityStorageInterface) {
180 181
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
182
    $ids = \Drupal::entityQuery('field_config')
183 184 185
      ->condition('id', $entity_type->id() . '.' . $bundle . '.', 'STARTS_WITH')
      ->execute();
    // Fetch all fields and key them by field name.
186
    $field_configs = FieldConfig::loadMultiple($ids);
187
    $result = array();
188 189
    foreach ($field_configs as $field_instance) {
      $result[$field_instance->getName()] = $field_instance;
190
    }
191

192
    return $result;
193 194 195
  }
}

196 197 198 199
/**
 * Implements hook_entity_bundle_rename().
 */
function field_entity_bundle_rename($entity_type, $bundle_old, $bundle_new) {
200 201 202 203 204 205 206 207 208
  $fields = entity_load_multiple_by_properties('field_config', array('entity_type' => $entity_type, 'bundle' => $bundle_old, 'include_deleted' => TRUE));
  foreach ($fields as $field) {
    $id_new = $field->entity_type . '.' . $bundle_new . '.' . $field->field_name;
    $field->set('id', $id_new);
    $field->bundle = $bundle_new;
    // Save non-deleted fields.
    if (!$field->isDeleted()) {
      $field->allowBundleRename();
      $field->save();
209
    }
210
    // Update deleted fields directly in the state storage.
211 212
    else {
      $state = \Drupal::state();
213 214 215
      $deleted_fields = $state->get('field.field.deleted') ?: array();
      $deleted_fields[$field->uuid] = $field->toArray();
      $state->set('field.field.deleted', $deleted_fields);
216
    }
217
  }
218 219 220 221 222
}

/**
 * Implements hook_entity_bundle_delete().
 *
223 224 225 226 227 228
 * This deletes the data for the field as well as the field themselves. This
 * function actually just marks the data and fields as deleted, leaving the
 * garbage collection for a separate process, because it is not always
 * possible to delete this much data in a single page request (particularly
 * since for some field types, the deletion is more than just a simple DELETE
 * query).
229 230
 */
function field_entity_bundle_delete($entity_type, $bundle) {
231 232 233 234
  // Get the fields on the bundle.
  $fields = entity_load_multiple_by_properties('field_config', array('entity_type' => $entity_type, 'bundle' => $bundle));
  foreach ($fields as $field) {
    $field->delete();
235
  }
236 237 238
}

/**
239
 * @} End of "defgroup field".
240
 */
241

242 243 244
/**
 * Assembles a partial entity structure with initial IDs.
 *
245
 * @param object $ids
246 247 248
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
249
 * @return \Drupal\Core\Entity\EntityInterface
250 251 252 253
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
254 255
  $entity_type = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $entity_type->getKey('id')) {
256
    $id_properties[$id_key] = $ids->entity_id;
257
  }
258
  if (isset($ids->revision_id) && $revision_key = $entity_type->getKey('revision')) {
259
    $id_properties[$revision_key] = $ids->revision_id;
260
  }
261
  if (isset($ids->bundle) && $bundle_key = $entity_type->getKey('bundle')) {
262
    $id_properties[$bundle_key] = $ids->bundle;
263 264
  }
  return entity_create($ids->entity_type, $id_properties);
265 266
}

267 268 269 270
/**
 * Implements hook_config_import_steps_alter().
 */
function field_config_import_steps_alter(&$sync_steps, ConfigImporter $config_importer) {
271
  $field_storages = \Drupal\field\ConfigImporterFieldPurger::getFieldStoragesToPurge(
272 273 274
    $config_importer->getStorageComparer()->getSourceStorage()->read('core.extension'),
    $config_importer->getStorageComparer()->getChangelist('delete')
  );
275
  if ($field_storages) {
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    // Add a step to the beginning of the configuration synchronization process
    // to purge field data where the module that provides the field is being
    // uninstalled.
    array_unshift($sync_steps, array('\Drupal\field\ConfigImporterFieldPurger', 'process'));
  };
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Adds a warning if field data will be permanently removed by the configuration
 * synchronization.
 *
 * @see \Drupal\field\ConfigImporterFieldPurger
 */
291
function field_form_config_admin_import_form_alter(&$form, FormStateInterface $form_state) {
292 293
  // Only display the message when there is a storage comparer available and the
  // form is not submitted.
294
  $user_input = $form_state->getUserInput();
295 296
  $storage_comparer = $form_state->get('storage_comparer');
  if ($storage_comparer && empty($user_input)) {
297
    $field_storages = \Drupal\field\ConfigImporterFieldPurger::getFieldStoragesToPurge(
298 299
      $storage_comparer->getSourceStorage()->read('core.extension'),
      $storage_comparer->getChangelist('delete')
300
    );
301 302
    if ($field_storages) {
      foreach ($field_storages as $field) {
303 304 305
        $field_labels[] = $field->label();
      }
      drupal_set_message(\Drupal::translation()->formatPlural(
306
        count($field_storages),
307 308 309 310 311 312 313
        'This synchronization will delete data from the field %fields.',
        'This synchronization will delete data from the fields: %fields.',
        array('%fields' => implode(', ', $field_labels))
      ), 'warning');
    }
  }
}