field.module 49.8 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
376
377
378
379
380
381
382
383
384
385
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
423
424
425
/**
 * 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.
  // @todo: Make 'field item class' mandatory.
  foreach ($field_types as $type_name => $type_info) {

    if (!empty($type_info['field item class'])) {
      $items[$type_name . '_field'] = 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',
      );
    }
  }
  return $items;
}

/**
 * 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)),
          'type' => $field['type'] . '_field',
          '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;
}

426
427
428
429
430
431
432
433
434
435
436
437
438
/**
 * 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.
439
 * @param \Drupal\Core\Entity\EntityInterface $entity
440
441
442
443
 *   The entity to be displayed.
 * @param $langcode
 *   The language code $entity has to be displayed in.
 */
444
function field_language_fallback(&$field_langcodes, EntityInterface $entity, $langcode) {
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
  // 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;
        }
      }
    }
  }
}

469
/**
470
 * Implements hook_cache_flush().
471
 */
472
473
474
475
476
477
478
479
480
function field_cache_flush() {
  // Request a flush of our cache table.
  return array('field');
}

/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
481
  // Refresh the 'active' status of fields.
482
483
484
  field_sync_field_status();
}

485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
/**
 * 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();
}

501
502
503
504
505
506
/**
 * 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.
507
508
509
  $modules = module_list();
  foreach ($modules as $module_name) {
    field_associate_fields($module_name);
510
  }
511
512
  db_update('field_config')
    ->fields(array('active' => 0))
513
    ->condition('module', $modules, 'NOT IN')
514
515
516
    ->execute();
  db_update('field_config')
    ->fields(array('storage_active' => 0))
517
    ->condition('storage_module', $modules, 'NOT IN')
518
    ->execute();
519
520
521
522
523
}

/**
 * Allows a module to update the database for fields and columns it controls.
 *
524
 * @param $module
525
526
527
 *   The name of the module to update on.
 */
function field_associate_fields($module) {
528
  // Associate field types.
529
  $field_types = (array) module_invoke($module, 'field_info');
530
  if ($field_types) {
531
532
    db_update('field_config')
      ->fields(array('module' => $module, 'active' => 1))
533
      ->condition('type', array_keys($field_types))
534
      ->execute();
535
  }
536
537
  // Associate storage backends.
  $storage_types = (array) module_invoke($module, 'field_storage_info');
538
  if ($storage_types) {
539
540
    db_update('field_config')
      ->fields(array('storage_module' => $module, 'storage_active' => 1))
541
      ->condition('storage_type', array_keys($storage_types))
542
543
      ->execute();
  }
544
545
}

546
/**
547
 * Helper function to get the default value for a field on an entity.
548
 *
549
 * @param \Drupal\Core\Entity\EntityInterface $entity
550
 *   The entity for the operation.
551
552
553
554
 * @param $field
 *   The field structure.
 * @param $instance
 *   The instance structure.
555
556
 * @param $langcode
 *   The field language to fill-in with the default value.
557
 */
558
function field_get_default_value(EntityInterface $entity, $field, $instance, $langcode = NULL) {
559
560
561
  $items = array();
  if (!empty($instance['default_value_function'])) {
    $function = $instance['default_value_function'];
562
    $items = $function($entity, $field, $instance, $langcode);
563
564
565
566
567
568
569
  }
  elseif (!empty($instance['default_value'])) {
    $items = $instance['default_value'];
  }
  return $items;
}

570
/**
571
 * Filters out empty field values.
572
 *
573
574
575
576
 * @param $field
 *   The field definition.
 * @param $items
 *   The field values to filter.
577
 *
578
579
580
 * @return
 *   The array of items without empty field values. The function also renumbers
 *   the array keys to ensure sequential deltas.
581
 */
582
function _field_filter_items($field, $items) {
583
584
  $function = $field['module'] . '_field_is_empty';
  foreach ((array) $items as $delta => $item) {
585
    // Explicitly break if the function is undefined.
586
587
    if ($function($item, $field)) {
      unset($items[$delta]);
588
589
    }
  }
590
  return array_values($items);
591
592
593
}

/**
594
595
596
597
598
599
600
601
602
 * 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.
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 */
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;
}

/**
617
618
619
 * Callback for usort() within _field_sort_items().
 *
 * Copied form element_sort(), which acts on #weight keys.
620
621
 */
function _field_sort_items_helper($a, $b) {
622
623
624
  $a_weight = (is_array($a) ? $a['_weight'] : 0);
  $b_weight = (is_array($b) ? $b['_weight'] : 0);
  return $a_weight - $b_weight;
625
626
627
}

/**
628
629
630
 * Callback for usort() within theme_field_multiple_value_form().
 *
 * Sorts using ['_weight']['#value']
631
632
 */
function _field_sort_items_value_helper($a, $b) {
633
634
635
  $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;
636
637
}

638
/**
639
640
 * Gets or sets administratively defined bundle settings.
 *
641
 * @param string $entity_type
642
 *   The type of $entity; e.g., 'node' or 'user'.
643
 * @param string $bundle
644
 *   The bundle name.
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 * @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.
666
 *
667
 * @return array|null
668
669
670
671
 *   If no $settings are passed, the current settings are returned.
 */
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
  if (isset($settings)) {
672
    variable_set('field_bundle_settings_' . $entity_type . '__' . $bundle, $settings);
673
    field_info_cache_clear();
674
675
  }
  else {
676
    $settings = variable_get('field_bundle_settings_' . $entity_type . '__' . $bundle, array());
677
678
679
680
    $settings += array(
      'view_modes' => array(),
      'extra_fields' => array(),
    );
681
682
683
    $settings['extra_fields'] += array(
      'form' => array(),
    );
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709

    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
710
711
    // definition in hook_entity_info_alter() specify they should use custom
    // settings by default.
712
    $entity_info = entity_get_info($entity_type);
713
714
    foreach ($entity_info['view_modes'] as $view_mode => $view_mode_info) {
      if (!isset($settings[$view_mode]['custom_settings']) && $view_mode_info['custom_settings']) {
715
716
717
718
719
720
721
722
723
        $settings[$view_mode]['custom_settings'] = TRUE;
      }
    }
    $cache[$entity_type][$bundle] = $settings;
  }

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

724
/**
725
 * Pre-render callback: Adjusts weights and visibility of non-field elements.
726
 */
727
728
729
730
function _field_extra_fields_pre_render($elements) {
  $entity_type = $elements['#entity_type'];
  $bundle = $elements['#bundle'];

731
732
733
734
  $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'];
735
736
    }
  }
737

738
739
740
  return $elements;
}

741
/**
742
 * Clears the field info and field data caches.
743
 */
744
function field_cache_clear() {
745
  cache('field')->deleteAll();
746
  field_info_cache_clear();
747
748
749
}

/**
750
751
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
752
753
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
754
755
756
757
758
759
760
761
762
763
 * 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.
764
765
766
767
768
769
 */
function field_filter_xss($string) {
  return filter_xss($string, _field_filter_xss_allowed_tags());
}

/**
770
 * Returns a list of tags allowed by field_filter_xss().
771
772
773
774
775
776
 */
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');
}

/**
777
 * Returns a human-readable list of allowed tags for display in help texts.
778
779
780
781
782
783
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
784
 * Returns a renderable array for a single field value.
785
 *
786
 * @param \Drupal\Core\Entity\EntityInterface $entity
787
 *   The entity containing the field to display. Must at least contain the ID
788
789
790
 *   key and the field data to display.
 * @param $field_name
 *   The name of the field to display.
791
 * @param $item
792
793
794
 *   The field value to display, as found in
 *   $entity->field_name[$langcode][$delta].
 * @param $display
795
796
 *   Can be either the name of a view mode, or an array of display settings. See
 *   field_view_field() for more information.
797
 * @param $langcode
798
799
800
 *   (Optional) The language of the value in $item. If not provided, the current
 *   language will be assumed.
 *
801
 * @return
802
 *   A renderable array for the field value.
803
 */
804
function field_view_value(EntityInterface $entity, $field_name, $item, $display = array(), $langcode = NULL) {
805
  $output = array();
806

807
808
  if ($field = field_info_field($field_name)) {
    // Determine the langcode that will be used by language fallback.
809
    $langcode = field_language($entity, $field_name, $langcode);
810

811
812
813
814
    // 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);
815
    $elements = field_view_field($clone, $field_name, $display, $langcode);
816

817
818
819
820
    // Extract the part of the render array we need.
    $output = isset($elements[0]) ? $elements[0] : array();
    if (isset($elements['#access'])) {
      $output['#access'] = $elements['#access'];
821
822
    }
  }
823
824

  return $output;
825
826
827
}

/**
828
 * Returns a renderable array for the value of a single field in an entity.
829
 *
830
 * The resulting output is a fully themed field with label and multiple values.
831
 *
832
833
834
835
 * 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.
836
 * - Do not use to display all fields in an entity, use
837
 *   field_attach_prepare_view() and field_attach_view() instead.
838
839
 * - The field_view_value() function can be used to output a single formatted
 *   field value, without label or wrapping field markup.
840
 *
841
842
843
 * The function takes care of invoking the prepare_view steps. It also respects
 * field access permissions.
 *
844
845
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity containing the field to display.
846
847
 * @param $field_name
 *   The name of the field to display.
848
 * @param $display_options
849
 *   Can be either:
850
851
 *   - The name of a view mode. The field will be displayed according to the
 *     display settings specified for this view mode in the $instance
852
853
854
 *     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.
855
 *   - An array of display options. The following key/value pairs are allowed:
856
857
858
859
 *     - 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
860
861
862
 *       '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.
863
 *     - settings: (array) Settings specific to the formatter. Defaults to the
864
 *       formatter's default settings, specified in hook_field_formatter_info().
865
866
867
 *     - weight: (float) The weight to assign to the renderable element.
 *       Defaults to 0.
 * @param $langcode
868
869
 *   (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
870
 *   available for the given language code. If no language code is provided the
871
 *   current language will be used.
872
 *
873
 * @return
874
 *   A renderable array for the field value.
875
876
 *
 * @see field_view_value()
877
 */
878
function field_view_field(EntityInterface $entity, $field_name, $display_options = array(), $langcode = NULL) {
879
  $output = array();
880
  $bundle = $entity->bundle();
881

882
  // Return nothing if the field doesn't exist.
883
  $instance = field_info_instance($entity->entityType(), $field_name, $bundle);
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
  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) {
909
    $display_langcode = field_language($entity, $field_name, $langcode);
910
911
912
913
914
915
916
917
918
    $items = $entity->{$field_name}[$display_langcode];

    // 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;
919
      _field_invoke_multiple('prepare_view', $entity->entityType(), array($id => $entity), $null, $null, $options);
920
921
922
923
924

      // Then let the formatter do its own specific massaging.
      $items_multi = array($id => $entity->{$field_name}[$display_langcode]);
      $formatter->prepareView(array($id => $entity), $display_langcode, $items_multi);
      $items = $items_multi[$id];
925
926
    }

927
928
    // Build the renderable array.
    $result = $formatter->view($entity, $display_langcode, $items);
929

930
931
932
933
934
935
936
937
    // 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);
938

939
940
    if (isset($result[$field_name])) {
      $output = $result[$field_name];
941
    }
942
  }
943

944
945
946
  return $output;
}

947
948
949
/**
 * Returns the field items in the language they currently would be displayed.
 *
950
 * @param \Drupal\Core\Entity\EntityInterface $entity
951
952
953
954
955
956
957
958
959
960
 *   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
 *   An array of field items keyed by delta if available, FALSE otherwise.
 */
961
962
function field_get_items(EntityInterface $entity, $field_name, $langcode = NULL) {
  $langcode = field_language($entity, $field_name, $langcode);
963
964
965
  return isset($entity->{$field_name}[$langcode]) ? $entity->{$field_name}[$langcode] : FALSE;
}

966
/**
967
 * Determines whether a field has any data.
968
969
970
 *
 * @param $field
 *   A field structure.
971
 *
972
 * @return
973
 *   TRUE if the field has data for any entity; FALSE otherwise.
974
975
 */
function field_has_data($field) {
976
977
978
979
  $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) {
980
981
982
983
984
    // 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;
    }
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
    $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;
1002
1003
}

1004
/**
1005
 * Determines whether the user has access to a given field.
1006
 *
1007
 * @param string $op
1008
 *   The operation to be performed. Possible values:
1009
1010
 *   - edit
 *   - view
1011
1012
1013
 * @param array $field
 *   The full field structure array for the field on which the operation is to
 *   be performed. See field_info_field().
1014
1015
 * @param $entity_type
 *   The type of $entity; for example, 'node' or 'user'.
1016
 * @param $entity
1017
 *   (optional) The entity for the operation.
1018
1019
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
1020
 *
1021
 * @return
1022
 *   TRUE if the operation is allowed; FALSE if the operation is denied.
1023
 */
1024
function field_access($op, $field, $entity_type, $entity = NULL, $account = NULL) {
1025
1026
  global $user;

1027
  if (!isset($account)) {
1028
1029
1030
    $account = $user;
  }

1031
1032
  foreach (module_implements('field_access') as $module) {
    $function = $module . '_field_access';
1033
    $access = $function($op, $field, $entity_type, $entity, $account);
1034
    if ($access === FALSE) {
1035
1036
1037
1038
1039
1040
      return FALSE;
    }
  }
  return TRUE;
}

1041
/**
1042
 * Extracts the bundle name from a bundle object.
1043
 *
1044
 * @param $entity_type
1045
 *   The type of $entity; e.g., 'node' or 'user'.
1046
 * @param $bundle
1047
 *   The bundle object (or string if bundles for this entity type do not exist
1048
 *   as standalone objects).
1049
 *
1050
1051
1052
 * @return
 *   The bundle name.
 */
1053
function field_extract_bundle($entity_type, $bundle) {
1054
1055
1056
1057
  if (is_string($bundle)) {
    return $bundle;
  }

1058
  $info = entity_get_info($entity_type);
1059
1060
  if (is_object($bundle) && isset($info['bundle_keys']['bundle']) && isset($bundle->{$info['bundle_keys']['bundle']})) {
    return $bundle->{$info['bundle_keys']['bundle']};
1061
1062
1063
  }
}

1064
1065
1066
1067
1068
1069
1070
1071
/**
 * 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);
}

1072
/**
1073
 * Theme preprocess function for theme_field() and field.tpl.php.
1074
 *
1075
 * @see theme_field()
1076
1077
 * @see field.tpl.php
 */
1078
function template_preprocess_field(&$variables, $hook) {
1079
1080
  $element = $variables['element'];

1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
  // 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'], '_', '-');
1107
  $variables['attributes']['class'] = array(
1108
1109
1110
1111
    'field',
    'field-name-' . $variables['field_name_css'],
    'field-type-' . $variables['field_type_css'],
    'field-label-' . $element['#label_display'],
1112
  );
1113
1114
1115
  // 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') {
1116
    $variables['attributes']['class'][] = 'clearfix';
1117
  }
1118

1119
1120
  // Add specific suggestions that can override the default implementation.
  $variables['theme_hook_suggestions'] = array(
1121
    'field__' . $element['#field_type'],
1122
1123
1124
1125
    'field__' . $element['#field_name'],
    'field__' . $element['#bundle'],
    'field__' . $element['#field_name'] . '__' . $element['#bundle'],
  );
1126
1127
}

1128
/**
1129
 * Theme process function for theme_field() and field.tpl.php.
1130
 *
1131
 * @see theme_field()
1132
1133
 * @see field.tpl.php
 */
1134
function template_process_field(&$variables, $hook) {
1135
  static $default_attributes;
1136
1137
  // The default theme implementation is a function, so template_process() does
  // not automatically run, so we need to flatten the classes and attributes
1138
1139
1140
  // here. For best performance, only instantiate Drupal\Core\Template\Attribute
  // when needed, and note that template_preprocess_field() does not initialize
  // the *_attributes variables.
1141
  if (!isset($default_attributes)) {
1142
    $default_attributes = new Attribute;
1143
  }
1144
1145
1146
  $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);