field.module 17.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
use Drupal\field\Entity\FieldStorageConfig;
16

17
/*
18 19 20
 * 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.
21
 */
22
require_once __DIR__ . '/field.purge.inc';
23

24 25 26
/**
 * @defgroup field Field API
 * @{
27 28 29 30 31 32 33 34
 * 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.
35
 *
36 37 38
 * 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
39 40 41 42 43 44 45 46 47
 * 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
48
 * node storage loads an Article node, it loads the values of the
49 50
 * 'subtitle' and 'photo' fields because they are both attached to the 'node'
 * bundle 'article'.
51
 *
52 53 54 55 56 57
 * - @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
58
 *   bulk deletion operations such as deletion of field storage or field.
59 60 61
 */

/**
62
 * Implements hook_help().
63
 */
64
function field_help($route_name, RouteMatchInterface $route_match) {
65 66
  switch ($route_name) {
    case 'help.page.field':
67
      $field_ui_url = \Drupal::moduleHandler()->moduleExists('field_ui') ? \Drupal::url('help.page', array('name' => 'field_ui')) : '#';
68 69
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
70 71 72 73 74 75 76 77 78 79 80 81 82 83
      $output .= '<p>' . t('The Field module allows custom data fields to be defined for <em>entity</em> types (see below). 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('!field-ui-help' => $field_ui_url, '!field' => 'https://drupal.org/documentation/modules/field')). '</p>';
      $output .= '<h3>' . t('Terminology') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Entities and entity types') . '</dt>';
      $output .= '<dd>' . t('The website\'s content and configuration is managed using <em>entities</em>, which are grouped into <em>entity types</em>. <em>Content entity types</em> are the entity types for site content (such as the main site content, comments, custom blocks, taxonomy terms, and user accounts). <em>Configuration entity types</em> are used to store configuration information for your site, such as individual views in the Views module, and settings for your main site content types.') . '</dd>';
      $output .= '<dt>' . t('Entity sub-types') . '</dt>';
      $output .= '<dd>' . t('Some content entity types are further grouped into sub-types (for example, you could have article and page content types within the main site content entity type, and tag and category vocabularies within the taxonomy term entity type); other entity types, such as user accounts, do not have sub-types. Programmers use the term <em>bundle</em> for entity sub-types.') . '</dd>';
      $output .= '<dt>' . t('Fields and field types') . '</dt>';
      $output .= '<dd>' . t('Content entity types and sub-types store most of their text, file, and other information in <em>fields</em>. Fields are grouped by <em>field type</em>; field types define what type of data can be stored in that field, such as text, images, or taxonomy term references.') . '</dd>';
      $output .= '<dt>' . t('Formatters and view modes') . '</dd>';
      $output .= '<dd>' . t('Content entity types and sub-types can have one or more <em>view modes</em>, used for displaying the entity items. For instance, a content item could be viewed in full content mode on its own page, teaser mode in a list, or RSS mode in a feed. In each view mode, each field can be hidden or displayed, and if it is displayed, you can choose and configure the <em>formatter</em> that is used to display the field. For instance, a long text field can be displayed trimmed or full-length, and taxonomy term reference fields can be displayed in plain text or linked to the taxonomy term page.') . '</dd>';
      $output .= '<dt>' . t('Widgets and form modes') . '</dd>';
      $output .= '<dd>' . t('Content entity types and sub-types can have one or more <em>form modes</em>, used for editing. For instance, a content item could be edited in a compact format with only some fields editable, or a full format that allows all fields to be edited. In each form mode, each field can be hidden or displayed, and if it is displayed, you can choose and configure the <em>widget</em> that is used to edit the field. For instance, a taxonomy term reference field can be edited using a select list, radio buttons, or an autocomplete widget.') . '</dd>';
      $output .= '</dl>';
84 85
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
86
      $output .= '<dt>' . t('Enabling field types, widgets, and formatters') . '</dt>';
87 88 89
      $output .= '<dd>' . t('The Field module provides the infrastructure for fields; the field types, formatters, and widgets are provided by Drupal core or 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, formatters, 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')) . '</dd>';

      $output .= '<h3>' . t('Field, widget, and formatter information') . '</h3>';
90

91 92 93
      // Make a list of all widget, formatter, and field modules currently
      // enabled, ordered by displayed module name (module names are not
      // translated).
94 95
      $items = array();
      $info = system_get_info('module');
96
      $widgets = \Drupal::service('plugin.manager.field.widget')->getDefinitions();
97
      $field_types = \Drupal::service('plugin.manager.field.field_type')->getUiDefinitions();
98
      $formatters = \Drupal::service('plugin.manager.field.formatter')->getDefinitions();
99
      $providers = array();
100
      foreach (array_merge($field_types, $widgets, $formatters) as $plugin) {
101
        $providers[] = $plugin['provider'];
102
      }
103 104 105 106 107 108 109 110
      $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')) {
111
            $items[] = \Drupal::l($display, new Url('help.page', array('name' => $provider)));
112 113 114 115
          }
          else {
            $items[] = $display;
          }
116 117
        }
      }
118
      if ($items) {
119 120
        $output .= '<dt>' . t('Provided by modules') . '</dt>';
        $output .= '<dd>' . t('Here is a list of the currently enabled field, formatter, and widget modules:');
121 122 123 124 125
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $items,
        );
        $output .= drupal_render($item_list);
126
        $output .= '</dd>';
127
      }
128 129 130 131 132 133 134

      $output .= '<dt>' . t('Provided by Drupal core') . '</dt>';
      $output .= '<dd>' . t('As mentioned previously, some field types, widgets, and formatters are provided by Drupal core. Here are some notes on how to use some of these:');
      $output .= '<ul>';
      $output .= '<li>' . t('<strong>Number fields</strong>: When you add a number field you can choose from three types: <em>decimal</em>, <em>float</em>, and <em>integer</em>. The <em>decimal</em> number field type allows users to enter exact decimal values, with fixed numbers of decimal places. The <em>float</em> number field type allows users to enter approximate decimal values. The <em>integer</em> number field type allows users to enter whole numbers, such as years (for example, 2012) or values (for example, 1, 2, 5, 305). It does not allow decimals.') . '</li>';
      $output .= '</ul></dd>';
      $output .= '</dl>';
135 136 137 138
      return $output;
  }
}

139
/**
140
 * Implements hook_cron().
141 142
 */
function field_cron() {
143
  // Do a pass of purging on deleted Field API data, if any exists.
144
  $limit = \Drupal::config('field.settings')->get('purge_batch_size');
145 146 147
  field_purge_batch($limit);
}

148
/**
149 150
 * Implements hook_system_info_alter().
 *
151
 * Goes through a list of all modules that provide a field type and makes them
152
 * required if there are any active fields of that type.
153
 */
154
function field_system_info_alter(&$info, Extension $file, $type) {
155 156
  // It is not safe to call entity_load_multiple_by_properties() during
  // maintenance mode.
157
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
158 159
    $field_storages = entity_load_multiple_by_properties('field_storage_config', array('module' => $file->getName(), 'include_deleted' => TRUE));
    if ($field_storages) {
160 161 162 163 164
      $info['required'] = TRUE;

      // Provide an explanation message (only mention pending deletions if there
      // remains no actual, non-deleted fields)
      $non_deleted = FALSE;
165
      foreach ($field_storages as $field_storage) {
166
        if (!$field_storage->isDeleted()) {
167 168 169 170 171
          $non_deleted = TRUE;
          break;
        }
      }
      if ($non_deleted) {
172
        $explanation = t('Fields type(s) in use');
173 174 175 176 177 178
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
179 180 181
  }
}

182 183 184 185
/**
 * Implements hook_entity_field_storage_info().
 */
function field_entity_field_storage_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type) {
186
  if (\Drupal::entityManager()->getStorage($entity_type->id()) instanceof DynamicallyFieldableEntityStorageInterface) {
187 188
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
189
    $ids = \Drupal::entityQuery('field_storage_config')
190 191 192
      ->condition('id', $entity_type->id() . '.', 'STARTS_WITH')
      ->execute();
    // Fetch all fields and key them by field name.
193
    $field_storages = FieldStorageConfig::loadMultiple($ids);
194
    $result = array();
195 196
    foreach ($field_storages as $field_storage) {
      $result[$field_storage->getName()] = $field_storage;
197
    }
198

199 200 201 202
    return $result;
  }
}

203
/**
204
 * Implements hook_entity_bundle_field_info().
205
 */
206
function field_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
207
  if (\Drupal::entityManager()->getStorage($entity_type->id()) instanceof DynamicallyFieldableEntityStorageInterface) {
208 209
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
210
    $ids = \Drupal::entityQuery('field_config')
211 212 213
      ->condition('id', $entity_type->id() . '.' . $bundle . '.', 'STARTS_WITH')
      ->execute();
    // Fetch all fields and key them by field name.
214
    $field_configs = FieldConfig::loadMultiple($ids);
215
    $result = array();
216 217
    foreach ($field_configs as $field_instance) {
      $result[$field_instance->getName()] = $field_instance;
218
    }
219

220
    return $result;
221 222 223
  }
}

224 225 226 227
/**
 * Implements hook_entity_bundle_rename().
 */
function field_entity_bundle_rename($entity_type, $bundle_old, $bundle_new) {
228 229 230 231 232 233 234 235 236
  $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();
237
    }
238
    // Update deleted fields directly in the state storage.
239 240
    else {
      $state = \Drupal::state();
241 242 243
      $deleted_fields = $state->get('field.field.deleted') ?: array();
      $deleted_fields[$field->uuid] = $field->toArray();
      $state->set('field.field.deleted', $deleted_fields);
244
    }
245
  }
246 247 248 249 250
}

/**
 * Implements hook_entity_bundle_delete().
 *
251 252 253 254 255 256
 * 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).
257 258
 */
function field_entity_bundle_delete($entity_type, $bundle) {
259 260 261 262
  // 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();
263
  }
264 265 266
}

/**
267
 * @} End of "defgroup field".
268
 */
269

270 271 272
/**
 * Assembles a partial entity structure with initial IDs.
 *
273
 * @param object $ids
274 275 276
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
277
 * @return \Drupal\Core\Entity\EntityInterface
278 279 280 281
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
282 283
  $entity_type = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $entity_type->getKey('id')) {
284
    $id_properties[$id_key] = $ids->entity_id;
285
  }
286
  if (isset($ids->revision_id) && $revision_key = $entity_type->getKey('revision')) {
287
    $id_properties[$revision_key] = $ids->revision_id;
288
  }
289
  if (isset($ids->bundle) && $bundle_key = $entity_type->getKey('bundle')) {
290
    $id_properties[$bundle_key] = $ids->bundle;
291 292
  }
  return entity_create($ids->entity_type, $id_properties);
293 294
}

295 296 297 298
/**
 * Implements hook_config_import_steps_alter().
 */
function field_config_import_steps_alter(&$sync_steps, ConfigImporter $config_importer) {
299
  $field_storages = \Drupal\field\ConfigImporterFieldPurger::getFieldStoragesToPurge(
300 301 302
    $config_importer->getStorageComparer()->getSourceStorage()->read('core.extension'),
    $config_importer->getStorageComparer()->getChangelist('delete')
  );
303
  if ($field_storages) {
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
    // 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
 */
319
function field_form_config_admin_import_form_alter(&$form, FormStateInterface $form_state) {
320 321
  // Only display the message when there is a storage comparer available and the
  // form is not submitted.
322
  $user_input = $form_state->getUserInput();
323 324
  $storage_comparer = $form_state->get('storage_comparer');
  if ($storage_comparer && empty($user_input)) {
325
    $field_storages = \Drupal\field\ConfigImporterFieldPurger::getFieldStoragesToPurge(
326 327
      $storage_comparer->getSourceStorage()->read('core.extension'),
      $storage_comparer->getChangelist('delete')
328
    );
329 330
    if ($field_storages) {
      foreach ($field_storages as $field) {
331 332 333
        $field_labels[] = $field->label();
      }
      drupal_set_message(\Drupal::translation()->formatPlural(
334
        count($field_storages),
335 336 337 338 339 340 341
        'This synchronization will delete data from the field %fields.',
        'This synchronization will delete data from the fields: %fields.',
        array('%fields' => implode(', ', $field_labels))
      ), 'warning');
    }
  }
}