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

7
use Drupal\Core\Entity\EntityInterface;
8
use Drupal\Core\Language\Language;
9
use Drupal\Core\Template\Attribute;
10
use Drupal\field\FieldInterface;
11
12
use Drupal\field\FieldInstanceInterface;
use Drupal\Core\Entity\EntityNG;
13

14
/*
15
16
17
 * 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.
18
 */
19
20
21
22
23
require_once __DIR__ . '/field.crud.inc';
require_once __DIR__ . '/field.info.inc';
require_once __DIR__ . '/field.multilingual.inc';
require_once __DIR__ . '/field.attach.inc';
require_once __DIR__ . '/field.form.inc';
24

25
26
27
/**
 * @defgroup field Field API
 * @{
28
29
30
31
32
33
34
35
 * 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.
36
 *
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 * The Field API defines two primary data structures, Field and Instance, and
 * the concept of a Bundle. A Field defines a particular type of data that can
 * be attached to entities. A Field Instance is a Field attached to a single
 * 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
 * node system uses the Field Attach API to load all fields for an Article node,
 * it passes the node's entity type (which is 'node') and content type (which is
 * 'article') as the node's bundle. field_attach_load() then loads the
 * 'subtitle' and 'photo' fields because they are both attached to the 'node'
 * bundle 'article'.
54
 *
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 * - @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_crud Field CRUD API @endlink: Create, updates, and deletes
 *   fields, bundles (a.k.a. "content types"), and instances. Modules use this
 *   API, often in hook_install(), to create custom data structures.
 *
 * - @link field_attach Field Attach API @endlink: Connects entity types to the
 *   Field API. Field Attach API functions load, store, generate Form API
 *   structures, display, and perform a variety of other functions for field
 *   data connected to individual entities. Fieldable entity types like node and
 *   user use this API to make themselves fieldable.
 *
 * - @link field_info Field Info API @endlink: Exposes information about all
 *   fields, instances, widgets, and related information defined by or with the
 *   Field API.
 *
 * - @link field_storage Field Storage API @endlink: Provides a pluggable back
 *   -end storage system for actual field data. The default implementation,
 *   field_sql_storage.module, stores field data in the local SQL database.
 *
 * - @link field_purge Field API bulk data deletion @endlink: Cleans up after
79
 *   bulk deletion operations such as deletion of field or field_instance.
80
81
 *
 * - @link field_language Field language API @endlink: Provides native
82
 *   multilingual support for the Field API.
83
84
85
 */

/**
86
 * Value for field API indicating a field accepts an unlimited number of values.
87
 */
88
const FIELD_CARDINALITY_UNLIMITED = -1;
89
90

/**
91
92
93
 * Value for field API indicating a widget doesn't accept default values.
 *
 * @see hook_field_widget_info()
94
 */
95
const FIELD_BEHAVIOR_NONE = 0x0001;
96

97
/**
98
99
100
101
102
103
104
105
 * Value for field API concerning widget default and multiple value settings.
 *
 * @see hook_field_widget_info()
 *
 * When used in a widget default context, indicates the widget accepts default
 * values. When used in a multiple value context for a widget that allows the
 * input of one single field value, indicates that the widget will be repeated
 * for each value input.
106
 */
107
const FIELD_BEHAVIOR_DEFAULT = 0x0002;
108

109
/**
110
111
112
 * Value for field API indicating a widget can receive several field values.
 *
 * @see hook_field_widget_info()
113
 */
114
const FIELD_BEHAVIOR_CUSTOM = 0x0004;
115
116

/**
117
118
119
 * Load the most recent version of an entity's field data.
 *
 * @see field_attach_load().
120
 */
121
const FIELD_LOAD_CURRENT = 'FIELD_LOAD_CURRENT';
122

123
/**
124
125
126
 * Load the version of an entity's field data specified in the entity.
 *
 * @see field_attach_load().
127
 */
128
const FIELD_LOAD_REVISION = 'FIELD_LOAD_REVISION';
129
130

/**
131
 * Implements hook_help().
132
133
134
135
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
136
137
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
138
      $output .= '<p>' . t('The Field module allows custom data fields to be defined for <em>entity</em> 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 online handbook entry for <a href="@field">Field module</a>.', array('@field-ui-help' => url('admin/help/field_ui'), '@field' => 'http://drupal.org/documentation/modules/field')) . '</p>';
139
140
141
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
142
      $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">Modules administration page</a>. Drupal core includes the following field type modules: Number (required), Text (required), List (required), Taxonomy (optional), Image (optional), and File (optional); the required Options module provides input widgets for other field modules. 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>. Currently enabled field and input widget modules:', array('@modules' => url('admin/modules'), '@contrib' => 'http://drupal.org/project/modules', '@options' => url('admin/help/options')));
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

      // Make a list of all widget and field modules currently enabled, in
      // order by displayed module name (module names are not translated).
      $items = array();
      $info = system_get_info('module');
      $modules = array_merge(module_implements('field_info'), module_implements('field_widget_info'));
      $modules = array_unique($modules);
      sort($modules);
      foreach ($modules as $module) {
        $display = $info[$module]['name'];
        if (module_hook($module, 'help')) {
          $items['items'][] = l($display, 'admin/help/' . $module);
        }
        else {
          $items['items'][] = $display;
        }
      }
      $output .= theme('item_list', $items) . '</dd>';
      $output .= '<dt>' . t('Managing field data storage') . '</dt>';
162
      $output .= '<dd>' . t('Developers of field modules can either use the default <a href="@sql-store">Field SQL Storage module</a> to store data for their fields, or a contributed or custom module developed using the <a href="@storage-api">field storage API</a>.', array('@storage-api' => 'http://api.drupal.org/api/group/field_storage/8', '@sql-store' => url('admin/help/field_sql_storage'))) . '</dd>';
163
      $output .= '</dl>';
164
165
166
167
168
      return $output;
  }
}

/**
169
 * Implements hook_theme().
170
171
 */
function field_theme() {
172
  return array(
173
    'field' => array(
174
      'render element' => 'element',
175
176
    ),
    'field_multiple_value_form' => array(
177
      'render element' => 'element',
178
179
180
181
    ),
  );
}

182
/**
183
 * Implements hook_cron().
184
185
 */
function field_cron() {
186
  // Refresh the 'active' status of fields.
187
  field_sync_field_status();
188
189

  // Do a pass of purging on deleted Field API data, if any exists.
190
  $limit = config('field.settings')->get('purge_batch_size');
191
192
193
  field_purge_batch($limit);
}

194
/**
195
196
 * Implements hook_system_info_alter().
 *
197
 * Goes through a list of all modules that provide a field type and makes them
198
 * required if there are any active fields of that type.
199
 */
200
function field_system_info_alter(&$info, $file, $type) {
201
  // It is not safe to call field_read_fields() during maintenance mode.
202
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
    $fields = field_read_fields(array('module' => $file->name), array('include_deleted' => TRUE));
    if ($fields) {
      $info['required'] = TRUE;

      // Provide an explanation message (only mention pending deletions if there
      // remains no actual, non-deleted fields)
      $non_deleted = FALSE;
      foreach ($fields as $field) {
        if (empty($field['deleted'])) {
          $non_deleted = TRUE;
          break;
        }
      }
      if ($non_deleted) {
        if (module_exists('field_ui')) {
218
          $explanation = t('Field type(s) in use - see <a href="@fields-page">Field list</a>', array('@fields-page' => url('admin/reports/fields')));
219
220
221
222
223
224
225
226
227
228
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
229
230
231
  }
}

232
233
234
235
236
237
/**
 * Implements hook_entity_create().
 */
function field_entity_create(EntityInterface $entity) {
  $info = $entity->entityInfo();
  if (!empty($info['fieldable'])) {
238
    field_populate_default_values($entity, $entity->language()->id);
239
240
241
242
243
244
245
246
247
248
249
250
251
  }
}

/**
 * Inserts a default value for each entity field not having one.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity for the operation.
 * @param string $langcode
 *   (optional) The field language code to fill-in with the default value.
 *   Defaults to the entity language.
 */
function field_populate_default_values(EntityInterface $entity, $langcode = NULL) {
252
253
254
  // Ensure we are working with a BC mode entity.
  $entity = $entity->getBCEntity();

255
  $entity_type = $entity->entityType();
256
  $langcode = $langcode ?: $entity->language()->id;
257
258
  foreach (field_info_instances($entity_type, $entity->bundle()) as $field_name => $instance) {
    $field = field_info_field($field_name);
259
    $field_langcode = field_is_translatable($entity_type, $field) ? $langcode : Language::LANGCODE_NOT_SPECIFIED;
260
261
262
263
264
265
266
267
268
269
    // We need to preserve existing values.
    if (empty($entity->{$field_name}) || !array_key_exists($field_langcode, $entity->{$field_name})) {
      $items = field_get_default_value($entity, $field, $instance, $field_langcode);
      if (!empty($items)) {
        $entity->{$field_name}[$field_langcode] = $items;
      }
    }
  }
}

270
271
272
273
274
275
276
277
278
279
/**
 * Implements hook_entity_field_info() to define all configured fields.
 */
function field_entity_field_info($entity_type) {
  $property_info = array();

  foreach (field_info_instances($entity_type) as $bundle_name => $instances) {
    $optional = $bundle_name != $entity_type;

    foreach ($instances as $field_name => $instance) {
280
      $definition = _field_generate_entity_field_definition($instance->getField());
281

282
283
284
285
286
287
      if ($optional) {
        $property_info['optional'][$field_name] = $definition;
        $property_info['bundle map'][$bundle_name][] = $field_name;
      }
      else {
        $property_info['definitions'][$field_name] = $definition;
288
289
290
291
292
293
294
      }
    }
  }

  return $property_info;
}

295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/**
 * Generates an entity field definition for a configurable field.
 *
 * @param \Drupal\field\FieldInterface $field
 *   The field definition.
 * @param \Drupal\field\FieldInstanceInterface $instance
 *   (Optional) The field instance definition.
 *
 * @return array
 *   The entity field definition.
 */
function _field_generate_entity_field_definition(FieldInterface $field, FieldInstanceInterface $instance = NULL) {
  // @todo: Allow for adding field type settings.
  $definition = array(
    'label' => t('Field !name', array('!name' => $field->id())),
    'type' => 'field_item:' . $field->type,
    'list' => TRUE,
    'configurable' => TRUE,
    'translatable' => !empty($field->translatable),
  );
  if ($instance) {
    $definition['instance'] = $instance;
  }

  return $definition;
}

322
323
324
325
326
327
328
329
/**
 * Implements hook_field_widget_info_alter().
 */
function field_field_widget_info_alter(&$info) {
  // Add the Hidden widget to all field types.
  $info['hidden']['field_types'] = array_keys(field_info_field_types());
}

330
331
332
333
334
335
336
337
/**
 * Applies language fallback rules to the fields attached to the given entity.
 *
 * Core language fallback rules simply check if fields have a field translation
 * for the requested language code. If so, the requested language is returned,
 * otherwise all the fallback candidates are inspected to see if there is a
 * field translation available in another language.
 * By default this is called by field_field_language_alter(), but this
338
 * behavior can be disabled by setting the 'field.settings.language_fallback'
339
340
341
342
 * variable to FALSE.
 *
 * @param $field_langcodes
 *   A reference to an array of language codes keyed by field name.
343
 * @param \Drupal\Core\Entity\EntityInterface $entity
344
345
346
347
 *   The entity to be displayed.
 * @param $langcode
 *   The language code $entity has to be displayed in.
 */
348
function field_language_fallback(&$field_langcodes, EntityInterface $entity, $langcode) {
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
  // Lazily init fallback candidates to avoid unnecessary calls.
  $fallback_candidates = NULL;

  foreach ($field_langcodes as $field_name => $field_langcode) {
    // If the requested language is defined for the current field use it,
    // otherwise search for a fallback value among the fallback candidates.
    if (isset($entity->{$field_name}[$langcode])) {
      $field_langcodes[$field_name] = $langcode;
    }
    elseif (!empty($entity->{$field_name})) {
      if (!isset($fallback_candidates)) {
        require_once DRUPAL_ROOT . '/core/includes/language.inc';
        $fallback_candidates = language_fallback_get_candidates();
      }
      foreach ($fallback_candidates as $fallback_langcode) {
        if (isset($entity->{$field_name}[$fallback_langcode])) {
          $field_langcodes[$field_name] = $fallback_langcode;
          break;
        }
      }
    }
  }
}

373
374
375
376
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
377
  // Refresh the 'active' status of fields.
378
379
380
  field_sync_field_status();
}

381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/**
 * Implements hook_modules_enabled().
 */
function field_modules_enabled($modules) {
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

/**
 * Implements hook_modules_disabled().
 */
function field_modules_disabled($modules) {
  // Refresh the 'active' status of fields.
  field_sync_field_status();
}

397
/**
398
 * Refreshes the 'active' and 'storage[active]' values for fields.
399
400
 */
function field_sync_field_status() {
401
402
403
404
405
406
407
408
  $module_handler = Drupal::moduleHandler();
  $state = Drupal::state();

  // Get both deleted and non-deleted field definitions.
  $fields = array();
  foreach (config_get_storage_names_with_prefix('field.field') as $name) {
    $field = Drupal::config($name)->get();
    $fields[$field['uuid']] = $field;
409
  }
410
411
  $deleted_fields = $state->get('field.field.deleted') ?: array();
  $fields += $deleted_fields;
412

413
414
  if (empty($fields)) {
    return;
415
  }
416
417
418
419
420
421

  // Set the 'module' and 'active' values for the current set of enabled
  // modules.
  $changed = array();
  $modules = $module_handler->getModuleList();
  foreach ($modules as $module => $module_info) {
422
    // Collect storage backends exposed by the module.
423
424
    $storage_types = (array) $module_handler->invoke($module, 'field_storage_info');

425
    if ($storage_types) {
426
427
428
429
430
431
432
433
434
      foreach ($fields as $uuid => &$field) {
        // Associate storage backends.
        if (isset($storage_types[$field['storage']['type']]) && ($field['storage']['module'] !== $module || !$field['storage']['active'])) {
          $field['storage']['module'] = $module;
          $field['storage']['active'] = TRUE;
          $changed[$uuid] = $field;
        }
      }
    }
435
  }
436

437
  $field_types = Drupal::service('plugin.manager.entity.field.field_type')->getDefinitions();
438
439
  // Set fields with missing field type or storage modules to inactive.
  foreach ($fields as $uuid => &$field) {
440
441
442
443
444
445
    // Associate field types.
    if (isset($field_types[$field['type']]) && ($field['module'] != $field_types[$field['type']]['module'] || !$field['active'])) {
      $field['module'] = $field_types[$field['type']]['module'];
      $field['active'] = TRUE;
      $changed[$uuid] = $field;
    }
446
447
448
449
    if (!isset($modules[$field['module']]) && $field['active']) {
      $field['active'] = FALSE;
      $changed[$uuid] = $field;
    }
450
    // Disassociate storage backends.
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
    if (!isset($modules[$field['storage']['module']]) && $field['storage']['active']) {
      $field['storage']['active'] = FALSE;
      $changed[$uuid] = $field;
    }
  }

  // Store the updated field definitions.
  foreach ($changed as $uuid => $field) {
    if (!empty($field['deleted'])) {
      $deleted_fields[$uuid] = $field;
    }
    else {
      Drupal::config('field.field.' . $field['id'])
        ->set('module', $field['module'])
        ->set('active', $field['active'])
        ->set('storage.module', $field['storage']['module'])
        ->set('storage.active', $field['storage']['active'])
        ->save();
    }
  }
  $state->set('field.field.deleted', $deleted_fields);

  field_cache_clear();
474
475
}

476
/**
477
 * Helper function to get the default value for a field on an entity.
478
 *
479
 * @param \Drupal\Core\Entity\EntityInterface $entity
480
 *   The entity for the operation.
481
482
483
484
 * @param $field
 *   The field structure.
 * @param $instance
 *   The instance structure.
485
486
 * @param $langcode
 *   The field language to fill-in with the default value.
487
 */
488
function field_get_default_value(EntityInterface $entity, $field, $instance, $langcode = NULL) {
489
490
491
  $items = array();
  if (!empty($instance['default_value_function'])) {
    $function = $instance['default_value_function'];
492
    $items = $function($entity, $field, $instance, $langcode);
493
494
495
496
497
498
499
  }
  elseif (!empty($instance['default_value'])) {
    $items = $instance['default_value'];
  }
  return $items;
}

500
/**
501
502
503
 * Callback for usort() within theme_field_multiple_value_form().
 *
 * Sorts using ['_weight']['#value']
504
505
 */
function _field_sort_items_value_helper($a, $b) {
506
507
508
  $a_weight = (is_array($a) && isset($a['_weight']['#value']) ? $a['_weight']['#value'] : 0);
  $b_weight = (is_array($b) && isset($b['_weight']['#value']) ? $b['_weight']['#value'] : 0);
  return $a_weight - $b_weight;
509
510
}

511
/**
512
513
 * Gets or sets administratively defined bundle settings.
 *
514
 * @param string $entity_type
515
 *   The type of $entity; e.g., 'node' or 'user'.
516
 * @param string $bundle
517
 *   The bundle name.
518
519
520
521
522
 * @param array|null $settings
 *   (optional) The settings to store, an associative array with the following
 *   elements:
 *   - view_modes: An associative array keyed by view mode, with the following
 *     key/value pairs:
523
524
525
 *     - status: Boolean specifying whether the view mode uses a dedicated set
 *       of display options (TRUE), or the 'default' options (FALSE). Defaults
 *       to FALSE.
526
527
528
529
530
531
532
533
534
535
536
537
538
 *   - extra_fields: An associative array containing the form and display
 *     settings for extra fields (also known as pseudo-fields):
 *     - form: An associative array whose keys are the names of extra fields,
 *       and whose values are associative arrays with the following elements:
 *       - weight: The weight of the extra field, determining its position on an
 *         entity form.
 *     - display: An associative array whose keys are the names of extra fields,
 *       and whose values are associative arrays keyed by the name of view
 *       modes. This array must include an item for the 'default' view mode.
 *       Each view mode sub-array contains the following elements:
 *       - weight: The weight of the extra field, determining its position when
 *         an entity is viewed.
 *       - visible: TRUE if the extra field is visible, FALSE otherwise.
539
 *
540
 * @return array|null
541
542
543
544
 *   If no $settings are passed, the current settings are returned.
 */
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
  if (isset($settings)) {
545
    variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $settings);
546
    field_info_cache_clear();
547
548
  }
  else {
549
    $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle, array());
550
551
    $settings += array(
      'view_modes' => array(),
552
      'form_modes' => array(),
553
    );
554
555
556
557
558

    return $settings;
  }
}

559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
/**
 * Returns form mode settings in a given bundle.
 *
 * @param string $entity_type
 *   The type of entity; e.g. 'node' or 'user'.
 * @param string $bundle
 *   The bundle name to return form mode settings for.
 *
 * @return
 *   An array keyed by form mode, with the following key/value pairs:
 *   - status: Boolean specifying whether the form mode uses a dedicated set of
 *     display options (TRUE), or the 'default' options (FALSE). Defaults to
 *     FALSE.
 */
function field_form_mode_settings($entity_type, $bundle) {
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$entity_type][$bundle])) {
    $bundle_settings = field_bundle_settings($entity_type, $bundle);
    $settings = $bundle_settings['form_modes'];
    // Include form modes for which nothing has been stored yet, but whose
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
    $form_modes = entity_get_form_modes($entity_type);
    foreach ($form_modes as $form_mode => $form_mode_info) {
      if (!isset($settings[$form_mode]['status']) && $form_mode_info['status']) {
        $settings[$form_mode]['status'] = TRUE;
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

  return $cache[$entity_type][$bundle];
}

594
595
596
597
598
599
600
601
602
603
/**
 * Returns view mode settings in a given bundle.
 *
 * @param $entity_type
 *   The type of entity; e.g. 'node' or 'user'.
 * @param $bundle
 *   The bundle name to return view mode settings for.
 *
 * @return
 *   An array keyed by view mode, with the following key/value pairs:
604
605
606
 *   - status: Boolean specifying whether the view mode uses a dedicated set of
 *     display options (TRUE), or the 'default' options (FALSE). Defaults to
 *     FALSE.
607
608
609
610
611
612
613
614
 */
function field_view_mode_settings($entity_type, $bundle) {
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$entity_type][$bundle])) {
    $bundle_settings = field_bundle_settings($entity_type, $bundle);
    $settings = $bundle_settings['view_modes'];
    // Include view modes for which nothing has been stored yet, but whose
615
616
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
617
618
    $view_modes = entity_get_view_modes($entity_type);
    foreach ($view_modes as $view_mode => $view_mode_info) {
619
620
      if (!isset($settings[$view_mode]['status']) && $view_mode_info['status']) {
        $settings[$view_mode]['status'] = TRUE;
621
622
623
624
625
626
627
628
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

  return $cache[$entity_type][$bundle];
}

629
/**
630
 * Clears the field info and field data caches.
631
 */
632
function field_cache_clear() {
633
  cache('field')->deleteAll();
634
  field_info_cache_clear();
635
636
637
}

/**
638
639
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
640
641
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
642
643
644
645
646
647
648
649
650
651
 * Used for items entered by administrators, like field descriptions, allowed
 * values, where some (mainly inline) mark-up may be desired (so
 * drupal_htmlspecialchars() is not acceptable).
 *
 * @param $string
 *   The string with raw HTML in it.
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not valid
 *   UTF-8.
652
653
 */
function field_filter_xss($string) {
654
  return _filter_htmlcorrector(filter_xss($string, _field_filter_xss_allowed_tags()));
655
656
657
}

/**
658
 * Returns a list of tags allowed by field_filter_xss().
659
660
661
662
663
664
 */
function _field_filter_xss_allowed_tags() {
  return array('a', 'b', 'big',  'code', 'del', 'em', 'i', 'ins',  'pre', 'q', 'small', 'span', 'strong', 'sub', 'sup', 'tt', 'ol', 'ul', 'li', 'p', 'br', 'img');
}

/**
665
 * Returns a human-readable list of allowed tags for display in help texts.
666
667
668
669
670
671
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
672
 * Returns a renderable array for a single field value.
673
 *
674
 * @param \Drupal\Core\Entity\EntityInterface $entity
675
 *   The entity containing the field to display. Must at least contain the ID
676
677
678
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
679
 * @param $item
680
681
682
 *   The field value to display, as found in
 *   $entity->field_name[$langcode][$delta].
 * @param $display
683
684
 *   Can be either the name of a view mode, or an array of display settings. See
 *   field_view_field() for more information.
685
 * @param $langcode
686
687
688
 *   (Optional) The language of the value in $item. If not provided, the current
 *   language will be assumed.
 *
689
 * @return
690
 *   A renderable array for the field value.
691
 */
692
function field_view_value(EntityInterface $entity, $field_name, $item, $display = array(), $langcode = NULL) {
693
  $output = array();
694

695
696
697
  // Ensure we are working with a BC mode entity.
  $entity = $entity->getBCEntity();

698
699
  if ($field = field_info_field($field_name)) {
    // Determine the langcode that will be used by language fallback.
700
    $langcode = field_language($entity, $field_name, $langcode);
701

702
703
704
705
    // Push the item as the single value for the field, and defer to
    // field_view_field() to build the render array for the whole field.
    $clone = clone $entity;
    $clone->{$field_name}[$langcode] = array($item);
706
    $elements = field_view_field($clone, $field_name, $display, $langcode);
707

708
709
710
711
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
712
713
    }
  }
714
715

  return $output;
716
717
718
}

/**
719
 * Returns a renderable array for the value of a single field in an entity.
720
 *
721
 * The resulting output is a fully themed field with label and multiple values.
722
 *
723
724
725
726
 * This function can be used by third-party modules that need to output an
 * isolated field.
 * - Do not use inside node (or other entities) templates, use
 *   render($content[FIELD_NAME]) instead.
727
 * - Do not use to display all fields in an entity, use
728
 *   field_attach_prepare_view() and field_attach_view() instead.
729
730
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
731
 *
732
733
734
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
735
736
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity containing the field to display.
737
738
 * @param $field_name
 *   The name of the field to display.
739
 * @param $display_options
740
 *   Can be either:
741
742
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
743
744
745
 *     definition for the field in the entity's bundle. If no display settings
 *     are found for the view mode, the settings for the 'default' view mode
 *     will be used.
746
 *   - An array of display options. The following key/value pairs are allowed:
747
748
749
750
 *     - label: (string) Position of the label. The default 'field' theme
 *       implementation supports the values 'inline', 'above' and 'hidden'.
 *       Defaults to 'above'.
 *     - type: (string) The formatter to use. Defaults to the
751
752
 *       'default_formatter' for the field type. The default formatter will also
 *       be used if the requested formatter is not available.
753
 *     - settings: (array) Settings specific to the formatter. Defaults to the
754
 *       formatter's default settings.
755
756
757
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
758
759
 *   (Optional) The language code the field values are to be shown in. The
 *   site's current language fallback logic will be applied when no values are
760
 *   available for the given language code. If no language code is provided the
761
 *   current language will be used.
762
 *
763
 * @return
764
 *   A renderable array for the field value.
765
766
 *
 * @see field_view_value()
767
 */
768
function field_view_field(EntityInterface $entity, $field_name, $display_options = array(), $langcode = NULL) {
769
  $output = array();
770
  $bundle = $entity->bundle();
771
  $entity_type = $entity->entityType();
772

773
  // Return nothing if the field doesn't exist.
774
  $instance = field_info_instance($entity_type, $field_name, $bundle);
775
776
777
778
779
780
781
  if (!$instance) {
    return $output;
  }

  // Get the formatter object.
  if (is_string($display_options)) {
    $view_mode = $display_options;
782
    $formatter = entity_get_render_display($entity, $view_mode)->getRenderer($field_name);
783
784
785
786
787
788
789
790
791
  }
  else {
    $view_mode = '_custom';
    // hook_field_attach_display_alter() needs to receive the 'prepared'
    // $display_options, so we cannot let preparation happen internally.
    $field = field_info_field($field_name);
    $formatter_manager = drupal_container()->get('plugin.manager.field.formatter');
    $display_options = $formatter_manager->prepareConfiguration($field['type'], $display_options);
    $formatter = $formatter_manager->getInstance(array(
792
      'field_definition' => $instance,
793
794
795
796
797
798
799
      'view_mode' => $view_mode,
      'prepare' => FALSE,
      'configuration' => $display_options,
    ));
  }

  if ($formatter) {
800
    $display_langcode = field_language($entity, $field_name, $langcode);
801
802
803
804
805
806
807
808
809
810
811

    // Get the items.
    if ($entity->getNGEntity() instanceof EntityNG) {
      $items = $entity->getTranslation($display_langcode)->get($field_name);
      $definition = $entity->getPropertyDefinition($field_name);
    }
    else {
      $definitions = \Drupal::entityManager()->getFieldDefinitions($entity_type, $bundle);
      $definition = $definitions[$field_name];
      $itemsBC = isset($entity->{$field_name}[$display_langcode]) ? $entity->{$field_name}[$display_langcode] : array();
      $items = \Drupal::typedData()->create($definitions[$field_name], $itemsBC, $field_name, $entity);
812
    }
813

814
    // Invoke the formatter's prepareView() and view() methods.
815
816
817
818
819
    $id = $entity->id();
    $itemsBC_multi = array($id => $items->getValue());
    $formatter->prepareView(array($id => $entity), $display_langcode, $itemsBC_multi);
    $itemsBC = $itemsBC_multi[$id];
    $result = $formatter->view($entity, $display_langcode, $itemsBC);
820

821
822
823
824
825
826
    // Invoke hook_field_attach_view_alter() to let other modules alter the
    // renderable array, as in a full field_attach_view() execution.
    $context = array(
      'entity' => $entity,
      'view_mode' => $view_mode,
      'display_options' => $display_options,
827
      'langcode' => $display_langcode,
828
829
    );
    drupal_alter('field_attach_view', $result, $context);
830

831
832
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
833
    }
834
  }
835

836
837
838
  return $output;
}

839
840
841
/**
 * Returns the field items in the language they currently would be displayed.
 *
842
 * @param \Drupal\Core\Entity\EntityInterface $entity
843
844
845
846
847
848
849
850
 *   The entity containing the data to be displayed.
 * @param $field_name
 *   The field to be displayed.
 * @param $langcode
 *   (optional) The language code $entity->{$field_name} has to be displayed in.
 *   Defaults to the current language.
 *
 * @return
851
 *   An array with available field items keyed by delta.
852
 */
853
function field_get_items(EntityInterface $entity, $field_name, $langcode = NULL) {
854
  $entity = $entity->getBCEntity();
855
  $langcode = field_language($entity, $field_name, $langcode);
856
  return isset($entity->{$field_name}[$langcode]) ? $entity->{$field_name}[$langcode] : array();
857
858
}

859
/**
860
 * Determines whether the user has access to a given field.
861
 *
862
 * @param string $op
863
 *   The operation to be performed. Possible values:
864
865
 *   - edit
 *   - view
866
867
 * @param \Drupal\field\FieldInterface $field
 *   The field on which the operation is to be performed.
868
869
 * @param $entity_type
 *   The type of $entity; for example, 'node' or 'user'.
870
 * @param $entity
871
 *   (optional) The entity for the operation.
872
873
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
874
 *
875
 * @return
876
 *   TRUE if the operation is allowed; FALSE if the operation is denied.
877
 */
878
function field_access($op, FieldInterface $field, $entity_type, $entity = NULL, $account = NULL) {
879
880
  global $user;

881
  if (!isset($account)) {
882
883
884
    $account = $user;
  }

885
886
  foreach (module_implements('field_access') as $module) {
    $function = $module . '_field_access';
887
    $access = $function($op, $field, $entity_type, $entity, $account);
888
    if ($access === FALSE) {
889
890
891
892
893
894
      return FALSE;
    }
  }
  return TRUE;
}

895
/**
896
 * Extracts the bundle name from a bundle object.
897
 *
898
 * @param $entity_type
899
 *   The type of $entity; e.g., 'node' or 'user'.
900
 * @param $bundle
901
 *   The bundle object (or string if bundles for this entity type do not exist
902
 *   as standalone objects).
903
 *
904
905
906
 * @return
 *   The bundle name.
 */
907
function field_extract_bundle($entity_type, $bundle) {
908
909
910
911
  if (is_string($bundle)) {
    return $bundle;
  }

912
  $info = entity_get_info($entity_type);
913
914
  if (is_object($bundle) && isset($info['bundle_keys']['bundle']) && isset($bundle->{$info['bundle_keys']['bundle']})) {
    return $bundle->{$info['bundle_keys']['bundle']};
915
916
917
  }
}

918
919
920
921
922
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
923
  $page['#attached']['css'][$path . '/css/field.module.css'] = array('every_page' => TRUE);
924
925
}

926
/**
927
 * Prepares variables for field templates.
928
 *
929
930
931
932
933
934
935
936
937
 * Default template: field.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - element: A render element representing the field.
 *   - attributes: A string containing the attributes for the wrapping div.
 *   - title_attributes: A string containing the attributes for the title.
 *   - content_attributes: A string containing the attributes for the content's
 *     div.
938
 */
939
function template_preprocess_field(&$variables, $hook) {
940
941
  $element = $variables['element'];

942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
  // There's some overhead in calling check_plain() so only call it if the label
  // variable is being displayed. Otherwise, set it to NULL to avoid PHP
  // warnings if a theme implementation accesses the variable even when it's
  // supposed to be hidden. If a theme implementation needs to print a hidden
  // label, it needs to supply a preprocess function that sets it to the
  // sanitized element title or whatever else is wanted in its place.
  $variables['label_hidden'] = ($element['#label_display'] == 'hidden');
  $variables['label'] = $variables['label_hidden'] ? NULL : check_plain($element['#title']);

  // We want other preprocess functions and the theme implementation to have
  // fast access to the field item render arrays. The item render array keys
  // (deltas) should always be a subset of the keys in #items, and looping on
  // those keys is faster than calling element_children() or looping on all keys
  // within $element, since that requires traversal of all element properties.
  $variables['items'] = array();
  foreach ($element['#items'] as $delta => $item) {
    if (!empty($element[$delta])) {
      $variables['items'][$delta] = $element[$delta];
    }
  }

  // Add default CSS classes. Since there can be many fields rendered on a page,
  // save some overhead by calling strtr() directly instead of
  // drupal_html_class().
  $variables['field_name_css'] = strtr($element['#field_name'], '_', '-');
  $variables['field_type_css'] = strtr($element['#field_type'], '_', '-');
968
  $variables['attributes']['class'] = array(
969
970
971
972
    'field',
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
973
  );
974
  // Add a "clearfix" class to the wrapper since we float the label and the
975
  // field items in field.module.css if the label is inline.
976
  if ($element['#label_display'] == 'inline') {
977
    $variables['attributes']['class'][] = 'clearfix';
978
  }
979

980
981
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(
982
    'field__' . $element['#field_type'],
983
984
985
986
    'field__' . $element['#field_name'],
    'field__' . $element['#bundle'],
    'field__' . $element['#field_name'] . '__' . $element['#bundle'],
  );
987
988
}

989
/**
990
 * Theme process function for theme_field() and field.html.twig.
991
 *
992
 * @see theme_field()
993
 * @see field.html.twig
994
 */
995
function template_process_field(&$variables, $hook) {
996
  static $default_attributes;
997
998
  // The default theme implementation is a function, so template_process() does
  // not automatically run, so we need to flatten the classes and attributes
999
1000
1001
  // here. For best performance, only instantiate Drupal\Core\Template\Attribute
  // when needed, and note that template_preprocess_field() does not initialize
  // the *_attributes variables.
1002
  if (!isset($default_attributes)) {
1003
    $default_attributes = new Attribute;
1004
  }
1005
1006
1007
  $variables['attributes'] = isset($variables['attributes']) ? new Attribute($variables['attributes']) : clone $default_attributes;
  $variables['title_attributes'] = isset($variables['title_attributes']) ? new Attribute($variables['title_attributes']) : clone($default_attributes);
  $variables['content_attributes'] = isset($variables['content_attributes']) ? new Attribute($variables['content_attributes']) : clone($default_attributes);
1008
  foreach ($variables['items'] as $delta => $item) {
1009
    $variables['item_attributes'][$delta] = isset($variables['item_attributes'][$delta]) ? new Attribute($variables['item_attributes'][$delta]) : clone($default_attributes);
1010
1011
  }
}
1012

1013
/**
1014
 * @} End of "defgroup field".
1015
 */
1016
1017

/**
1018
 * Returns HTML for a field.
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 *
 * This is the default theme implementation to display the value of a field.
 * Theme developers who are comfortable with overriding theme functions may do
 * so in order to customize this markup. This function can be overridden with
 * varying levels of specificity. For example, for a field named 'body'
 * displayed on the 'article' content type, any of the following functions will
 * override this default implementation. The first of these functions that
 * exists is used:
 * - THEMENAME_field__body__article()
 * - THEMENAME_field__article()
 * - THEMENAME_field__body()
 * - THEMENAME_field()
 *
 * Theme developers who prefer to customize templates instead of overriding
1033
1034
 * functions may copy the "field.html.twig" from the "modules/field/theme"
 * folder of the Drupal installation to somewhere within the theme's folder and
1035
 * customize it, just like customizing other Drupal templates such as
1036
 * page.html.twig or node.html.twig. However, it takes longer for the server to
1037
1038
 * process templates than to call a function, so for websites with many fields
 * displayed on a page, this can result in a noticeable slowdown of the website.
1039
 * For these websites, developers are discouraged from placing a field.html.twig
1040
1041
1042
1043
 * file into the theme's folder, but may customize templates for specific
 * fields. For example, for a field named 'body' displayed on the 'article'
 * content type, any of the following templates will override this default
 * implementation. The first of these templates that exists is used:
1044
1045
1046
1047
 * - field--body--article.html.twig
 * - field--article.html.twig
 * - field--body.html.twig
 * - field.html.twig
1048
 * So, if the body field on the article content type needs customization, a
1049
 * field--body--article.html.twig file can be added within the theme's folder.
1050
 * Because it's a template, it will result in slightly more time needed to
1051
1052
 * display that field, but it will not impact other fields, and therefore, is
 * unlikely to cause a noticeable change in website performance. A very rough
1053
1054
1055
1056
1057
1058
 * guideline is that if a page is being displayed with more than 100 fields and
 * they are all themed with a template instead of a function, it can add up to
 * 5% to the time it takes to display that page. This is a guideline only and
 * the exact performance impact depends on the server configuration and the
 * details of the website.
 *
1059
1060
 * @param $variables
 *   An associative array containing:
1061
1062
 *   - label_hidden: A boolean indicating whether to show or hide the field
 *     label.
1063
1064
 *   - title_attributes: A string containing the attributes for the title.
 *   - label: The label for the field.
1065
 *   - content_attributes: A string containing the attributes for the content's
1066
1067
1068
1069
1070
1071
 *     div.
 *   - items: An array of field items.
 *   - item_attributes: An array of attributes for each item.
 *   - classes: A string containing the classes for the wrapping div.
 *   - attributes: A string containing the attributes for the wrapping div.
 *
1072
1073
 * @see template_preprocess_field()
 * @see template_process_field()
1074
 * @see field.html.twig
1075
1076
1077
1078
1079
1080
1081
1082
 *
 * @ingroup themeable
 */
function theme_field($variables) {
  $output = '';

  // Render the label, if it's not hidden.
  if (!$variables['label_hidden']) {
1083
    $output .= '<div class="field-label"' . $variables['title_attributes'] . '>' . $variables['label'] . '</div>';
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
  }

  // Render the items.
  $output .= '<div class="field-items"' . $variables['content_attributes'] . '>';
  foreach ($variables['items'] as $delta => $item) {
    $classes = 'field-item ' . ($delta % 2 ? 'odd' : 'even');
    $output .= '<div class="' . $classes . '"' . $variables['item_attributes'][$delta] . '>' . drupal_render($item) . '</div>';
  }
  $output .= '</div>';

  // Render the top-level DIV.
1095
  $output = '<div' . $variables['attributes'] . '>' . $output . '</div>';
1096
1097
1098

  return $output;
}
1099
1100
1101
1102
1103
1104
1105
1106

/**
 * Assembles a partial entity structure with initial IDs.
 *
 * @param stdClass $ids
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
1107
 * @return \Drupal\Core\Entity\EntityInterface
1108
1109
1110
1111
1112
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
  $info = entity_get_info($ids->entity_type);
1113
1114
1115
  if (isset($info['entity_keys']['id'])) {
    $id_properties[$info['entity_keys']['id']] = $ids->entity_id;
  }
1116
1117
  if (!empty($info['entity_keys']['revision']) && isset($ids->revision_id)) {
    $id_properties[$info['entity_keys']['revision']] = $ids->revision_id;
1118
  }
1119
1120
  if (!empty($info['entity_keys']['bundle']) && isset($ids->bundle)) {
    $id_properties[$info['entity_keys']['bundle']] = $ids->bundle;
1121
1122
  }
  return entity_create($ids->entity_type, $id_properties);
1123
1124
}

1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
/**
 * Implements hook_hook_info().
 */
function field_hook_info() {
  $hooks['field_views_data'] = array(
    'group' => 'views',
  );
  $hooks['field_views_data_alter'] = array(
    'group' => 'views',
  );

  return $hooks;
}