field.module 51.5 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\Template\Attribute;
9

10
/*
11
12
13
 * 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.
14
 */
15
16
17
18
19
20
require_once DRUPAL_ROOT . '/core/modules/field/field.crud.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.default.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.info.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.multilingual.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.attach.inc';
require_once DRUPAL_ROOT . '/core/modules/field/field.form.inc';
21

22
23
24
/**
 * @defgroup field Field API
 * @{
25
26
27
28
29
30
31
32
 * 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.
33
 *
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 * 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'.
51
52
53
54
 *
 * Field definitions are represented as an array of key/value pairs.
 *
 * array $field:
55
 * - id: (integer, read-only) The primary identifier of the field. It is
56
 *   assigned automatically by field_create_field().
57
 * - field_name: (string) The name of the field. Each field name is unique
58
59
 *   within Field API. When a field is attached to an entity, the field's data
 *   is stored in $entity->$field_name. Maximum length is 32 characters.
60
 * - type: (string) The type of the field, such as 'text' or 'image'. Field
61
 *   types are defined by modules that implement hook_field_info().
62
63
64
65
 * - entity_types: (array) The array of entity types that can hold instances of
 *   this field. If empty or not specified, the field can have instances in any
 *   entity type.
 * - cardinality: (integer) The number of values the field can hold. Legal
66
 *   values are any positive integer or FIELD_CARDINALITY_UNLIMITED.
67
68
 * - translatable: (integer) Whether the field is translatable.
 * - locked: (integer) Whether or not the field is available for editing. If
69
70
 *   TRUE, users can't change field settings or create new instances of the
 *   field in the UI. Defaults to FALSE.
71
 * - module: (string, read-only) The name of the module that implements the
72
 *   field type.
73
 * - active: (integer, read-only) TRUE if the module that implements the field
74
 *   type is currently enabled, FALSE otherwise.
75
 * - deleted: (integer, read-only) TRUE if this field has been deleted, FALSE
76
 *   otherwise. Deleted fields are ignored by the Field Attach API. This
77
78
79
80
81
82
83
84
85
 *   property exists because fields can be marked for deletion but only actually
 *   destroyed by a separate garbage-collection process.
 * - columns: (array, read-only) An array of the Field API columns used to store
 *   each value of this field. The column list may depend on field settings; it
 *   is not constant per field type. Field API column specifications are exactly
 *   like Schema API column specifications but, depending onthe field storage
 *   module in use, the name of the column may not represent an actual column in
 *   an SQL database.
 * - indexes: (array) An array of indexes on data columns, using the same
86
87
 *   definition format as Schema API index specifications. Only columns that
 *   appear in the 'columns' setting are allowed. Note that field types can
88
89
 *   specify default indexes, which can be modified or added to when creating a
 *   field.
90
 * - foreign keys: (optional) An associative array of relations, using the same
91
92
93
94
 *   structure as the 'foreign keys' definition of hook_schema(). Note,
 *   however, that the field data is not necessarily stored in SQL. Also, the
 *   possible usage is limited, as you cannot specify another field as
 *   related, only existing SQL tables, such as filter formats.
95
 * - settings: (array) A sub-array of key/value pairs of field-type-specific
96
97
 *   settings. Each field type module defines and documents its own field
 *   settings.
98
99
100
 * - storage: (array) A sub-array of key/value pairs identifying the storage
 *   backend to use for the for the field.
 *   - type: (string) The storage backend used by the field. Storage backends
101
 *     are defined by modules that implement hook_field_storage_info().
102
 *   - module: (string, read-only) The name of the module that implements the
103
 *     storage backend.
104
 *   - active: (integer, read-only) TRUE if the module that implements the
105
 *     storage backend is currently enabled, FALSE otherwise.
106
 *   - settings: (array) A sub-array of key/value pairs of settings. Each
107
 *     storage backend defines and documents its own settings.
108
109
110
111
 *
 * Field instance definitions are represented as an array of key/value pairs.
 *
 * array $instance:
112
113
114
115
 * - id: (integer, read-only) The primary identifier of this field instance. It
 *   is assigned automatically by field_create_instance().
 * - field_id: (integer, read-only) The foreign key of the field attached to the
 *   bundle by this instance. It is populated automatically by
116
 *   field_create_instance().
117
 * - field_name: (string) The name of the field attached to the bundle by this
118
 *   instance.
119
 * - entity_type: (string) The name of the entity type the instance is attached
120
 *   to.
121
122
123
124
125
126
127
128
 * - bundle: (string) The name of the bundle that the field is attached to.
 * - label: (string) A human-readable label for the field when used with this
 *   bundle. For example, the label will be the title of Form API elements for
 *   this instance.
 * - description: (string)A human-readable description for the field when used
 *   with this bundle. For example, the description will be the help text of
 *   Form API elements for this instance.
 * - required: (integer) TRUE if a value for this field is required when used
129
130
131
 *   with this bundle, FALSE otherwise. Currently, required-ness is only
 *   enforced during Form API operations, not by field_attach_load(),
 *   field_attach_insert(), or field_attach_update().
132
 * - default_value_function: (string) The name of the function, if any, that
133
 *   will provide a default value.
134
 * - default_value: (array) If default_value_function is not set, then fixed
135
 *   values can be provided.
136
137
138
139
140
 * - deleted: (integer, read-only) TRUE if this instance has been deleted, FALSE
 *   otherwise. Deleted instances are ignored by the Field Attach API. This
 *   property exists because instances can be marked for deletion but only
 *   actually destroyed by a separate garbage-collection process.
 * - settings: (array) A sub-array of key/value pairs of field-type-specific
141
142
 *   instance settings. Each field type module defines and documents its own
 *   instance settings.
143
144
145
 * - widget: (array) A sub-array of key/value pairs identifying the Form API
 *   input widget for the field when used by this bundle.
 *   - type: (string) The type of the widget, such as text_textfield. Widget
146
 *     types are defined by modules that implement hook_field_widget_info().
147
148
149
150
 *   - settings: (array) A sub-array of key/value pairs of widget-type-specific
 *     settings. Each field widget type module defines and documents its own
 *     widget settings.
 *   - weight: (float) The weight of the widget relative to the other elements
151
 *     in entity edit forms.
152
 *   - module: (string, read-only) The name of the module that implements the
153
 *     widget type.
154
 * - display: (array) A sub-array of key/value pairs identifying the way field
155
156
157
 *   values should be displayed in each of the entity type's view modes, plus
 *   the 'default' mode. For each view mode, Field UI lets site administrators
 *   define whether they want to use a dedicated set of display options or the
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 *   'default' options to reduce the number of displays to maintain as they add
 *   new fields. For nodes, on a fresh install, only the 'teaser' view mode is
 *   configured to use custom display options, all other view modes defined use
 *   the 'default' options by default. When programmatically adding field
 *   instances on nodes, it is therefore recommended to at least specify display
 *   options for 'default' and 'teaser'.
 *   - default: (array) A sub-array of key/value pairs describing the display
 *     options to be used when the field is being displayed in view modes that
 *     are not configured to use dedicated display options.
 *     - label: (string) Position of the label. 'inline', 'above' and 'hidden'
 *       are the values recognized by the default 'field' theme implementation.
 *     - type: (string) The type of the display formatter, or 'hidden' for no
 *       display.
 *     - settings: (array) A sub-array of key/value pairs of display options
 *       specific to the formatter.
 *       - weight: (float) The weight of the field relative to the other entity
 *         components displayed in this view mode.
 *       - module: (string, read-only) The name of the module which implements
 *         the display formatter.
 *   - some_mode: A sub-array of key/value pairs describing the display options
 *     to be used when the field is being displayed in the 'some_mode' view
 *     mode. Those options will only be actually applied at run time if the view
 *     mode is not configured to use default settings for this bundle.
181
182
183
 *     - ...
 *   - other_mode:
 *     - ...
184
 *
185
186
187
 * The (default) render arrays produced for field instances are documented at
 * field_attach_view().
 *
188
 * Bundles are represented by two strings, an entity type and a bundle name.
189
 *
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 * - @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
 *   bulk deletion operations such as field_delete_field() and
 *   field_delete_instance().
 *
 * - @link field_language Field language API @endlink: Provides native
218
 *   multilingual support for the Field API.
219
220
221
 */

/**
222
 * Value for field API indicating a field accepts an unlimited number of values.
223
 */
224
const FIELD_CARDINALITY_UNLIMITED = -1;
225
226

/**
227
228
229
 * Value for field API indicating a widget doesn't accept default values.
 *
 * @see hook_field_widget_info()
230
 */
231
const FIELD_BEHAVIOR_NONE = 0x0001;
232

233
/**
234
235
236
237
238
239
240
241
 * 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.
242
 */
243
const FIELD_BEHAVIOR_DEFAULT = 0x0002;
244

245
/**
246
247
248
 * Value for field API indicating a widget can receive several field values.
 *
 * @see hook_field_widget_info()
249
 */
250
const FIELD_BEHAVIOR_CUSTOM = 0x0004;
251
252

/**
253
254
255
 * Load the most recent version of an entity's field data.
 *
 * @see field_attach_load().
256
 */
257
const FIELD_LOAD_CURRENT = 'FIELD_LOAD_CURRENT';
258

259
/**
260
261
262
 * Load the version of an entity's field data specified in the entity.
 *
 * @see field_attach_load().
263
 */
264
const FIELD_LOAD_REVISION = 'FIELD_LOAD_REVISION';
265
266

/**
267
 * Implements hook_help().
268
269
270
271
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
272
273
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
274
      $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>';
275
276
277
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
278
      $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')));
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297

      // 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>';
298
      $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>';
299
      $output .= '</dl>';
300
301
302
303
304
      return $output;
  }
}

/**
305
 * Implements hook_theme().
306
307
 */
function field_theme() {
308
  return array(
309
    'field' => array(
310
      'render element' => 'element',
311
312
    ),
    'field_multiple_value_form' => array(
313
      'render element' => 'element',
314
315
316
317
    ),
  );
}

318
/**
319
 * Implements hook_cron().
320
321
 */
function field_cron() {
322
  // Refresh the 'active' status of fields.
323
  field_sync_field_status();
324
325

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

330
/**
331
332
 * Implements hook_system_info_alter().
 *
333
 * Goes through a list of all modules that provide a field type and makes them
334
 * required if there are any active fields of that type.
335
 */
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
function field_system_info_alter(&$info, $file, $type) {
  if ($type == 'module' && module_hook($file->name, 'field_info')) {
    $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')) {
353
          $explanation = t('Field type(s) in use - see <a href="@fields-page">Field list</a>', array('@fields-page' => url('admin/reports/fields')));
354
355
356
357
358
359
360
361
362
363
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
364
365
366
  }
}

367
368
369
370
371
372
373
374
375
/**
 * Implements hook_data_type_info() to register data types for all field types.
 */
function field_data_type_info() {
  $field_types = field_info_field_types();
  $items = array();

  // Expose data types for all the field type items.
  foreach ($field_types as $type_name => $type_info) {
376
377
378
379
380
381
    $data_type = isset($type_info['data_type']) ? $type_info['data_type'] : $type_name . '_field';
    $items[$data_type] = array(
      'label' => t('Field !label item', array('!label' => $type_info['label'])),
      'class' => $type_info['field item class'],
      'list class' => !empty($type_info['field class']) ? $type_info['field class'] : '\Drupal\Core\Entity\Field\Type\Field',
    );
382
383
384
385
  }
  return $items;
}

386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/**
 * Implements hook_entity_create().
 */
function field_entity_create(EntityInterface $entity) {
  $info = $entity->entityInfo();
  if (!empty($info['fieldable'])) {
    foreach ($entity->getTranslationLanguages() as $langcode => $language) {
      field_populate_default_values($entity, $langcode);
    }
  }
}

/**
 * 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) {
  $entity_type = $entity->entityType();
  $langcode = $langcode ?: $entity->language()->langcode;
  foreach (field_info_instances($entity_type, $entity->bundle()) as $field_name => $instance) {
    $field = field_info_field($field_name);
    $field_langcode = field_is_translatable($entity_type, $field) ? $langcode : LANGUAGE_NOT_SPECIFIED;
    // 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;
      }
    }
  }
}

423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/**
 * Implements hook_entity_field_info() to define all configured fields.
 */
function field_entity_field_info($entity_type) {
  $property_info = array();
  $field_types = field_info_field_types();

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

    foreach ($instances as $field_name => $instance) {
      $field = field_info_field($field_name);

      if (!empty($field_types[$field['type']]['field item class'])) {

        // @todo: Allow for adding field type settings.
        $definition = array(
          'label' => t('Field !name', array('!name' => $field_name)),
441
          'type' => isset($field_types[$field['type']]['data_type']) ? $field_types[$field['type']]['data_type'] :  $field['type'] . '_field',
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
          'configurable' => TRUE,
          'translatable' => !empty($field['translatable'])
        );

        if ($optional) {
          $property_info['optional'][$field_name] = $definition;
          $property_info['bundle map'][$bundle_name][] = $field_name;
        }
        else {
          $property_info['definitions'][$field_name] = $definition;
        }
      }
    }
  }

  return $property_info;
}

460
461
462
463
464
465
466
467
468
469
470
471
472
/**
 * 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
 * behavior can be disabled by setting the 'field_language_fallback'
 * variable to FALSE.
 *
 * @param $field_langcodes
 *   A reference to an array of language codes keyed by field name.
473
 * @param \Drupal\Core\Entity\EntityInterface $entity
474
475
476
477
 *   The entity to be displayed.
 * @param $langcode
 *   The language code $entity has to be displayed in.
 */
478
function field_language_fallback(&$field_langcodes, EntityInterface $entity, $langcode) {
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
  // 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;
        }
      }
    }
  }
}

503
504
505
506
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
507
  // Refresh the 'active' status of fields.
508
509
510
  field_sync_field_status();
}

511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
/**
 * 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();
}

527
528
529
530
531
532
/**
 * Refreshes the 'active' and 'storage_active' columns for fields.
 */
function field_sync_field_status() {
  // Refresh the 'active' and 'storage_active' columns according to the current
  // set of enabled modules.
533
  $modules = array_keys(drupal_container()->get('module_handler')->getModuleList());
534
535
  foreach ($modules as $module_name) {
    field_associate_fields($module_name);
536
  }
537
538
  db_update('field_config')
    ->fields(array('active' => 0))
539
    ->condition('module', $modules, 'NOT IN')
540
541
542
    ->execute();
  db_update('field_config')
    ->fields(array('storage_active' => 0))
543
    ->condition('storage_module', $modules, 'NOT IN')
544
    ->execute();
545
546
547
548
549
}

/**
 * Allows a module to update the database for fields and columns it controls.
 *
550
 * @param $module
551
552
553
 *   The name of the module to update on.
 */
function field_associate_fields($module) {
554
  // Associate field types.
555
  $field_types = (array) module_invoke($module, 'field_info');
556
  if ($field_types) {
557
558
    db_update('field_config')
      ->fields(array('module' => $module, 'active' => 1))
559
      ->condition('type', array_keys($field_types))
560
      ->execute();
561
  }
562
563
  // Associate storage backends.
  $storage_types = (array) module_invoke($module, 'field_storage_info');
564
  if ($storage_types) {
565
566
    db_update('field_config')
      ->fields(array('storage_module' => $module, 'storage_active' => 1))
567
      ->condition('storage_type', array_keys($storage_types))
568
569
      ->execute();
  }
570
571
}

572
/**
573
 * Helper function to get the default value for a field on an entity.
574
 *
575
 * @param \Drupal\Core\Entity\EntityInterface $entity
576
 *   The entity for the operation.
577
578
579
580
 * @param $field
 *   The field structure.
 * @param $instance
 *   The instance structure.
581
582
 * @param $langcode
 *   The field language to fill-in with the default value.
583
 */
584
function field_get_default_value(EntityInterface $entity, $field, $instance, $langcode = NULL) {
585
586
587
  $items = array();
  if (!empty($instance['default_value_function'])) {
    $function = $instance['default_value_function'];
588
    $items = $function($entity, $field, $instance, $langcode);
589
590
591
592
593
594
595
  }
  elseif (!empty($instance['default_value'])) {
    $items = $instance['default_value'];
  }
  return $items;
}

596
/**
597
 * Filters out empty field values.
598
 *
599
600
601
602
 * @param $field
 *   The field definition.
 * @param $items
 *   The field values to filter.
603
 *
604
605
606
 * @return
 *   The array of items without empty field values. The function also renumbers
 *   the array keys to ensure sequential deltas.
607
 */
608
function _field_filter_items($field, $items) {
609
610
  $function = $field['module'] . '_field_is_empty';
  foreach ((array) $items as $delta => $item) {
611
    // Explicitly break if the function is undefined.
612
613
    if ($function($item, $field)) {
      unset($items[$delta]);
614
615
    }
  }
616
  return array_values($items);
617
618
619
}

/**
620
621
622
623
624
625
626
627
628
 * Sorts items in a field according to user drag-and-drop reordering.
 *
 * @param $field
 *   The field definition.
 * @param $items
 *   The field values to sort.
 *
 * @return
 *   The sorted array of field items.
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 */
function _field_sort_items($field, $items) {
  if (($field['cardinality'] > 1 || $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED) && isset($items[0]['_weight'])) {
    usort($items, '_field_sort_items_helper');
    foreach ($items as $delta => $item) {
      if (is_array($items[$delta])) {
        unset($items[$delta]['_weight']);
      }
    }
  }
  return $items;
}

/**
643
644
645
 * Callback for usort() within _field_sort_items().
 *
 * Copied form element_sort(), which acts on #weight keys.
646
647
 */
function _field_sort_items_helper($a, $b) {
648
649
650
  $a_weight = (is_array($a) ? $a['_weight'] : 0);
  $b_weight = (is_array($b) ? $b['_weight'] : 0);
  return $a_weight - $b_weight;
651
652
653
}

/**
654
655
656
 * Callback for usort() within theme_field_multiple_value_form().
 *
 * Sorts using ['_weight']['#value']
657
658
 */
function _field_sort_items_value_helper($a, $b) {
659
660
661
  $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;
662
663
}

664
/**
665
666
 * Gets or sets administratively defined bundle settings.
 *
667
 * @param string $entity_type
668
 *   The type of $entity; e.g., 'node' or 'user'.
669
 * @param string $bundle
670
 *   The bundle name.
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 * @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:
 *     - custom_settings: Boolean specifying whether the view mode uses a
 *       dedicated set of display options (TRUE), or the 'default' options
 *       (FALSE). Defaults to FALSE.
 *   - 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.
692
 *
693
 * @return array|null
694
695
696
697
 *   If no $settings are passed, the current settings are returned.
 */
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
  if (isset($settings)) {
698
    variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $settings);
699
    field_info_cache_clear();
700
701
  }
  else {
702
    $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle, array());
703
704
705
706
    $settings += array(
      'view_modes' => array(),
      'extra_fields' => array(),
    );
707
708
709
    $settings['extra_fields'] += array(
      'form' => array(),
    );
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735

    return $settings;
  }
}

/**
 * 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:
 *   - custom_settings: Boolean specifying whether the view mode uses a
 *     dedicated set of display options (TRUE), or the 'default' options
 *     (FALSE). Defaults to FALSE.
 */
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
736
737
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
738
739
    $view_modes = entity_get_view_modes($entity_type);
    foreach ($view_modes as $view_mode => $view_mode_info) {
740
      if (!isset($settings[$view_mode]['custom_settings']) && $view_mode_info['custom_settings']) {
741
742
743
744
745
746
747
748
749
        $settings[$view_mode]['custom_settings'] = TRUE;
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

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

750
/**
751
 * Pre-render callback: Adjusts weights and visibility of non-field elements.
752
 */
753
754
755
756
function _field_extra_fields_pre_render($elements) {
  $entity_type = $elements['#entity_type'];
  $bundle = $elements['#bundle'];

757
758
759
760
  $extra_fields = field_info_extra_fields($entity_type, $bundle, 'form');
  foreach ($extra_fields as $name => $settings) {
    if (isset($elements[$name])) {
      $elements[$name]['#weight'] = $settings['weight'];
761
762
    }
  }
763

764
765
766
  return $elements;
}

767
/**
768
 * Clears the field info and field data caches.
769
 */
770
function field_cache_clear() {
771
  cache('field')->deleteAll();
772
  field_info_cache_clear();
773
774
775
}

/**
776
777
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
778
779
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
780
781
782
783
784
785
786
787
788
789
 * 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.
790
791
792
793
794
795
 */
function field_filter_xss($string) {
  return filter_xss($string, _field_filter_xss_allowed_tags());
}

/**
796
 * Returns a list of tags allowed by field_filter_xss().
797
798
799
800
801
802
 */
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');
}

/**
803
 * Returns a human-readable list of allowed tags for display in help texts.
804
805
806
807
808
809
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
810
 * Returns a renderable array for a single field value.
811
 *
812
 * @param \Drupal\Core\Entity\EntityInterface $entity
813
 *   The entity containing the field to display. Must at least contain the ID
814
815
816
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
817
 * @param $item
818
819
820
 *   The field value to display, as found in
 *   $entity->field_name[$langcode][$delta].
 * @param $display
821
822
 *   Can be either the name of a view mode, or an array of display settings. See
 *   field_view_field() for more information.
823
 * @param $langcode
824
825
826
 *   (Optional) The language of the value in $item. If not provided, the current
 *   language will be assumed.
 *
827
 * @return
828
 *   A renderable array for the field value.
829
 */
830
function field_view_value(EntityInterface $entity, $field_name, $item, $display = array(), $langcode = NULL) {
831
  $output = array();
832

833
834
  if ($field = field_info_field($field_name)) {
    // Determine the langcode that will be used by language fallback.
835
    $langcode = field_language($entity, $field_name, $langcode);
836

837
838
839
840
    // 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);
841
    $elements = field_view_field($clone, $field_name, $display, $langcode);
842

843
844
845
846
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
847
848
    }
  }
849
850

  return $output;
851
852
853
}

/**
854
 * Returns a renderable array for the value of a single field in an entity.
855
 *
856
 * The resulting output is a fully themed field with label and multiple values.
857
 *
858
859
860
861
 * 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.
862
 * - Do not use to display all fields in an entity, use
863
 *   field_attach_prepare_view() and field_attach_view() instead.
864
865
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
866
 *
867
868
869
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
870
871
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity containing the field to display.
872
873
 * @param $field_name
 *   The name of the field to display.
874
 * @param $display_options
875
 *   Can be either:
876
877
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
878
879
880
 *     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.
881
 *   - An array of display options. The following key/value pairs are allowed:
882
883
884
885
 *     - 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
886
887
888
 *       'default_formatter' for the field type, specified in hook_field_info().
 *       The default formatter will also be used if the requested formatter is
 *       not available.
889
 *     - settings: (array) Settings specific to the formatter. Defaults to the
890
 *       formatter's default settings, specified in hook_field_formatter_info().
891
892
893
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
894
895
 *   (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
896
 *   available for the given language code. If no language code is provided the
897
 *   current language will be used.
898
 *
899
 * @return
900
 *   A renderable array for the field value.
901
902
 *
 * @see field_view_value()
903
 */
904
function field_view_field(EntityInterface $entity, $field_name, $display_options = array(), $langcode = NULL) {
905
  $output = array();
906
  $bundle = $entity->bundle();
907

908
  // Return nothing if the field doesn't exist.
909
  $instance = field_info_instance($entity->entityType(), $field_name, $bundle);
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
  if (!$instance) {
    return $output;
  }

  // Get the formatter object.
  if (is_string($display_options)) {
    $view_mode = $display_options;
    $formatter = entity_get_render_display($entity, $view_mode)->getFormatter($field_name);
  }
  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(
      'instance' => $instance,
      'view_mode' => $view_mode,
      'prepare' => FALSE,
      'configuration' => $display_options,
    ));
  }

  if ($formatter) {
935
    $display_langcode = field_language($entity, $field_name, $langcode);
936
937
938
939
    $items = array();
    if (isset($entity->{$field_name}[$display_langcode])) {
      $items = $entity->{$field_name}[$display_langcode];
    }
940
941
942
943
944
945
946
947

    // Invoke prepare_view steps if needed.
    if (empty($entity->_field_view_prepared)) {
      $id = $entity->id();

      // First let the field types do their preparation.
      $options = array('field_name' => $field_name, 'langcode' => $display_langcode);
      $null = NULL;
948
      _field_invoke_multiple('prepare_view', $entity->entityType(), array($id => $entity), $null, $null, $options);
949
950

      // Then let the formatter do its own specific massaging.
951
952
953
954
      $items_multi = array($id => array());
      if (isset($entity->{$field_name}[$display_langcode])) {
        $items_multi[$id] = $entity->{$field_name}[$display_langcode];
      }
955
956
      $formatter->prepareView(array($id => $entity), $display_langcode, $items_multi);
      $items = $items_multi[$id];
957
958
    }

959
960
    // Build the renderable array.
    $result = $formatter->view($entity, $display_langcode, $items);
961

962
963
964
965
966
967
968
969
    // 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,
    );
    drupal_alter('field_attach_view', $result, $context);
970

971
972
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
973
    }
974
  }
975

976
977
978
  return $output;
}

979
980
981
/**
 * Returns the field items in the language they currently would be displayed.
 *
982
 * @param \Drupal\Core\Entity\EntityInterface $entity
983
984
985
986
987
988
989
990
 *   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
991
 *   An array with available field items keyed by delta.
992
 */
993
function field_get_items(EntityInterface $entity, $field_name, $langcode = NULL) {
994
  $entity = $entity->getBCEntity();
995
  $langcode = field_language($entity, $field_name, $langcode);
996
  return isset($entity->{$field_name}[$langcode]) ? $entity->{$field_name}[$langcode] : array();
997
998
}

999
/**
1000
 * Determines whether a field has any data.
1001
1002
1003
 *
 * @param $field
 *   A field structure.
1004
 *
1005
 * @return
1006
 *   TRUE if the field has data for any entity; FALSE otherwise.
1007
1008
 */
function field_has_data($field) {
1009
1010
1011
1012
  $field = field_info_field_by_id($field['id']);
  $columns = array_keys($field['columns']);
  $factory = drupal_container()->get('entity.query');
  foreach ($field['bundles'] as $entity_type => $bundle) {
1013
1014
1015
1016
1017
    // Entity Query throws an exception if there is no base table.
    $entity_info = entity_get_info($entity_type);
    if (!isset($entity_info['base_table'])) {
      continue;
    }
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
    $query = $factory->get($entity_type);
    $group = $query->orConditionGroup();
    foreach ($columns as $column) {
      $group->exists($field['field_name'] . '.' . $column);
    }
    $result = $query
      ->condition($group)
      ->count()
      ->accessCheck(FALSE)
      ->range(0, 1)
      ->execute();
    if ($result) {
      return TRUE;
    }
  }

  return FALSE;
1035
1036
}

1037
/**
1038
 * Determines whether the user has access to a given field.
1039
 *
1040
 * @param string $op
1041
 *   The operation to be performed. Possible values:
1042
1043
 *   - edit
 *   - view
1044
1045
1046
 * @param array $field
 *   The full field structure array for the field on which the operation is to
 *   be performed. See field_info_field().
1047
1048
 * @param $entity_type
 *   The type of $entity; for example, 'node' or 'user'.
1049
 * @param $entity
1050
 *   (optional) The entity for the operation.
1051
1052
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
1053
 *
1054
 * @return
1055
 *   TRUE if the operation is allowed; FALSE if the operation is denied.
1056
 */
1057
function field_access($op, $field, $entity_type, $entity = NULL, $account = NULL) {
1058
1059
  global $user;

1060
  if (!isset($account)) {
1061
1062
1063
    $account = $user;
  }

1064
1065
  foreach (module_implements('field_access') as $module) {
    $function = $module . '_field_access';
1066
    $access = $function($op, $field, $entity_type, $entity, $account);
1067
    if ($access === FALSE) {
1068
1069
1070
1071
1072
1073
      return FALSE;
    }
  }
  return TRUE;
}

1074
/**
1075
 * Extracts the bundle name from a bundle object.
1076
 *
1077
 * @param $entity_type
1078
 *   The type of $entity; e.g., 'node' or 'user'.
1079
 * @param $bundle
1080
 *   The bundle object (or string if bundles for this entity type do not exist
1081
 *   as standalone objects).
1082
 *
1083
1084
1085
 * @return
 *   The bundle name.
 */
1086
function field_extract_bundle($entity_type, $bundle) {
1087
1088
1089
1090
  if (is_string($bundle)) {
    return $bundle;
  }

1091
  $info = entity_get_info($entity_type);
1092
1093
  if (is_object($bundle) && isset($info['bundle_keys']['bundle']) && isset($bundle->{$info['bundle_keys']['bundle']})) {
    return $bundle->{$info['bundle_keys']['bundle']};
1094
1095
1096
  }
}

1097
1098
1099
1100
1101
1102
1103
1104
/**
 * Implements hook_page_build().
 */
function field_page_build(&$page) {
  $path = drupal_get_path('module', 'field');
  $page['#attached']['css'][$path . '/theme/field.css'] = array('every_page' => TRUE);
}

1105
/**
1106
 * Theme preprocess function for theme_field() and field.tpl.php.
1107
 *
1108
 * @see theme_field()
1109
1110
 * @see field.tpl.php
 */
1111
function template_preprocess_field(&$variables, $hook) {
1112
1113
  $element = $variables['element'];

1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
  // 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'], '_', '-');
1140
  $variables['attributes']['class'] = array(
1141
1142
1143
1144
    'field',
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
1145
  );
1146
1147
1148
  // Add a "clearfix" class to the wrapper since we float the label and the
  // field items in field.css if the label is inline.
  if ($element['#label_display'] == 'inline') {
1149
    $variables['attributes']['class'][] = 'clearfix';
1150
  }
1151

1152
1153
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(