field.module 20.5 KB
Newer Older
1
2
3
4
<?php
// $Id$
/**
 * @file
5
 * Attach custom data fields to Drupal objects.
6
7
 */

8
/*
9
10
11
 * 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.
12
13
 */
require(DRUPAL_ROOT . '/modules/field/field.crud.inc');
14
require(DRUPAL_ROOT . '/modules/field/field.default.inc');
15
require(DRUPAL_ROOT . '/modules/field/field.info.inc');
16
require(DRUPAL_ROOT . '/modules/field/field.multilingual.inc');
17
require(DRUPAL_ROOT . '/modules/field/field.attach.inc');
18
require(DRUPAL_ROOT . '/modules/field/field.form.inc');
19

20
21
22
23
24
25
26
/**
 * @defgroup field Field API
 * @{
 * Attach custom data fields to Drupal objects.
 *
 * The Field API allows custom data fields to be attached to Drupal
 * objects and takes care of storing, loading, editing, and rendering
27
 * field data. Any object type (node, user, etc.) can use the Field
28
 * API to make itself "fieldable" and thus allow fields to be attached
29
 * to it. Other modules can provide a user interface for managing custom
30
 * fields via a web browser as well as a wide and flexible variety of
31
32
33
34
 * data type, form element, and display format capabilities.
 *
 * - @link field_structs Data structures: Field, Instance, Bundle @endlink.
 *
35
36
 * - @link field_types Field Types API @endlink. Defines field types,
 *   widget types, and display formatters. Field modules use this API
37
38
39
 *   to provide field types like Text and Node Reference along with the
 *   associated form elements and display formatters.
 *
40
 * - @link field_crud Field CRUD API @endlink. Create, updates, and
41
42
 *   deletes fields, bundles (a.k.a. "content types"), and instances.
 *   Modules use this API, often in hook_install(), to create
43
 *   custom data structures.
44
 *
45
46
 * - @link field_attach Field Attach API @endlink. Connects object
 *   types to the Field API. Field Attach API functions load, store,
47
48
49
50
51
 *   generate Form API structures, display, and perform a vareity of
 *   other functions for field data connected to individual objects.
 *   Fieldable object types like node and user use this API to make
 *   themselves fieldable.
 *
52
 * - @link field_info Field Info API @endlink. Exposes information
53
54
55
 *   about all fields, instances, widgets, and related information
 *   defined by or with the Field API.
 *
56
57
 * - @link field_storage Field Storage API @endlink. Provides a
 *   pluggable back-end storage system for actual field data. The
58
59
 *   default implementation, field_sql_storage.module, stores field data
 *   in the local SQL database.
60
61
62
63

 * - @link field_purge Field API bulk data deletion @endlink. Cleans
 *   up after bulk deletion operations such as field_delete_field()
 *   and field_delete_instance().
64
65
66
67
68
69
70
71
 */

/**
 * Value for $field['cardinality'] property to indicate it can hold an
 * unlimited number of values.
 */
define('FIELD_CARDINALITY_UNLIMITED', -1);

72
73
74
75
76
77
78
/**
 * The language code assigned to untranslatable fields.
 *
 * Defined by ISO639-2 for "No linguistic content / Not applicable".
 */
define('FIELD_LANGUAGE_NONE', 'zxx');

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/**
 * TODO
 */
define('FIELD_BEHAVIOR_NONE', 0x0001);
/**
 * TODO
 */
define('FIELD_BEHAVIOR_DEFAULT', 0x0002);
/**
 * TODO
 */
define('FIELD_BEHAVIOR_CUSTOM', 0x0004);

/**
 * Age argument for loading the most recent version of an object's
 * field data with field_attach_load().
 */
define('FIELD_LOAD_CURRENT', 'FIELD_LOAD_CURRENT');
/**
 * Age argument for loading the version of an object's field data
 * specified in the object with field_attach_load().
 */
define('FIELD_LOAD_REVISION', 'FIELD_LOAD_REVISION');

103
104
105
/**
 * @name Field query flags
 * @{
106
 * Flags for field_attach_query().
107
108
 */

109
110
111
112
113
114
/**
 * Limit argument for field_attach_query() to request all available
 * objects instead of a limited number.
 */
define('FIELD_QUERY_NO_LIMIT', 'FIELD_QUERY_NO_LIMIT');

115
/**
116
117
 * Cursor return value for field_attach_query() to indicate that no
 * more data is available.
118
 */
119
define('FIELD_QUERY_COMPLETE', 'FIELD_QUERY_COMPLETE');
120
121
122
123

/**
 * @} End of "Field query flags".
 */
124
125
126
127
128
129
130
131
132

/**
 * Base class for all exceptions thrown by Field API functions.
 *
 * This class has no functionality of its own other than allowing all
 * Field API exceptions to be caught by a single catch block.
 */
class FieldException extends Exception {}

133
/**
134
 * Implement hook_flush_caches.
135
136
137
138
139
140
 */
function field_flush_caches() {
  return array('cache_field');
}

/**
141
 * Implement hook_help().
142
143
144
145
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
146
      $output = '<p>' . t('The Field API allows custom data fields to be attached to Drupal objects and takes care of storing, loading, editing, and rendering field data. Any object type (node, user, etc.) can use the Field API to make itself "fieldable" and thus allow fields to be attached to it.') . '</p>';
147
148
149
150
151
      return $output;
  }
}

/**
152
 * Implement hook_theme().
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 */
function field_theme() {
  $path = drupal_get_path('module', 'field') . '/theme';

  return array(
    'field' => array(
      'template' => 'field',
      'arguments' => array('element' => NULL),
      'path' => $path,
    ),
    'field_multiple_value_form' => array(
      'arguments' => array('element' => NULL),
    ),
  );
}

169
170
171
172
173
174
175
176
177
178
/**
 * Implement hook_cron().
 *
 * Purges some deleted Field API data, if any exists.
 */
function field_cron() {
  $limit = variable_get('field_purge_batch_size', 10);
  field_purge_batch($limit);
}

179
/**
180
 * Implement hook_modules_installed().
181
182
183
184
185
186
 */
function field_modules_installed($modules) {
  field_cache_clear();
}

/**
187
 * Implement hook_modules_uninstalled().
188
189
190
191
192
193
194
195
196
197
 */
function field_modules_uninstalled($modules) {
  module_load_include('inc', 'field', 'field.crud');
  foreach ($modules as $module) {
    // TODO D7: field_module_delete is not yet implemented
    // field_module_delete($module);
  }
}

/**
198
 * Implement hook_modules_enabled().
199
200
201
202
203
204
205
206
207
 */
function field_modules_enabled($modules) {
  foreach ($modules as $module) {
    field_associate_fields($module);
  }
  field_cache_clear();
}

/**
208
 * Implement hook_modules_disabled().
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 */
function field_modules_disabled($modules) {
  foreach ($modules as $module) {
    db_update('field_config')
      ->fields(array('active' => 0))
      ->condition('module', $module)
      ->execute();
    db_update('field_config_instance')
      ->fields(array('widget_active' => 0))
      ->condition('widget_module', $module)
      ->execute();
    field_cache_clear(TRUE);
  }
}

/**
 * Allows a module to update the database for fields and columns it controls.
 *
 * @param string $module
 *   The name of the module to update on.
 */
function field_associate_fields($module) {
  $module_fields = module_invoke($module, 'field_info');
  if ($module_fields) {
    foreach ($module_fields as $name => $field_info) {
      watchdog('field', 'Updating field type %type with module %module.', array('%type' => $name, '%module' => $module));
      db_update('field_config')
        ->fields(array('module' => $module, 'active' => 1))
        ->condition('type', $name)
        ->execute();
    }
  }
  $module_widgets = module_invoke($module, 'widget_info');
  if ($module_widgets) {
    foreach ($module_widgets as $name => $widget_info) {
      watchdog('field', 'Updating widget type %type with module %module.', array('%type' => $name, '%module' => $module));
      db_update('field_config_instance')
        ->fields(array('widget_module' => $module, 'widget_active' => 1))
        ->condition('widget_type', $name)
        ->execute();
    }
  }
}

253
254
255
256
257
258
259
260
261
262
263
/**
 * Helper function to get the default value for a field on an object.
 *
 * @param $obj_type
 *   The type of $object; e.g. 'node' or 'user'.
 * @param $object
 *   The object for the operation.
 * @param $field
 *   The field structure.
 * @param $instance
 *   The instance structure.
264
265
 * @param $langcode
 *   The field language to fill-in with the default value.
266
 */
267
function field_get_default_value($obj_type, $object, $field, $instance, $langcode = NULL) {
268
269
270
  $items = array();
  if (!empty($instance['default_value_function'])) {
    $function = $instance['default_value_function'];
271
    if (function_exists($function)) {
272
      $items = $function($obj_type, $object, $field, $instance, $langcode);
273
274
275
276
277
278
279
280
    }
  }
  elseif (!empty($instance['default_value'])) {
    $items = $instance['default_value'];
  }
  return $items;
}

281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/**
 * Helper function to filter out empty values.
 *
 * On order to keep marker rows in the database, the function ensures
 * that the right number of 'all columns NULL' values is kept.
 *
 * @param array $field
 * @param array $items
 * @return array
 *   returns filtered and adjusted item array
 *
 * TODO D7: poorly named...
 */
function field_set_empty($field, $items) {
  $function = $field['module'] . '_field_is_empty';
296
  // We ensure the function is loaded, but explicitly break if it is missing.
297
  function_exists($function);
298
  foreach ((array) $items as $delta => $item) {
299
300
    if ($function($item, $field)) {
      unset($items[$delta]);
301
302
    }
  }
303
  return array_values($items);
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
}

/**
 * Helper function to sort items in a field according to
 * user drag-n-drop reordering.
 */
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;
}

/**
 * Sort function for items order.
 * (copied form element_sort(), which acts on #weight keys)
 */
function _field_sort_items_helper($a, $b) {
  $a_weight = (is_array($a) && isset($a['_weight'])) ? $a['_weight'] : 0;
  $b_weight = (is_array($b) && isset($b['_weight'])) ? $b['_weight'] : 0;
  if ($a_weight == $b_weight) {
    return 0;
  }
  return ($a_weight < $b_weight) ? -1 : 1;
}

/**
 * Same as above, using ['_weight']['#value']
 */
function _field_sort_items_value_helper($a, $b) {
  $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;
  if ($a_weight == $b_weight) {
    return 0;
  }
  return ($a_weight < $b_weight) ? -1 : 1;
}

/**
 * Registry of available build modes.
 */
function field_build_modes($obj_type) {
351
  $info = &drupal_static(__FUNCTION__, array());
352
353

  if (!isset($info[$obj_type])) {
354
    $info[$obj_type] = module_invoke_all('field_build_modes', $obj_type);
355
356
357
358
  }
  return $info[$obj_type];
}

359
360
361
362
363
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
/**
 * Registry of pseudo-field components in a given bundle.
 *
 * @param $bundle_name
 *   The bundle name.
 * @return
 *   The array of pseudo-field elements in the bundle.
 */
function field_extra_fields($bundle_name) {
  $info = &drupal_static(__FUNCTION__, array());

  if (empty($info)) {
    $info = array();
    $bundles = field_info_bundles();
    foreach ($bundles as $bundle => $bundle_label) {
      // Gather information about non-field object additions.
      $extra = module_invoke_all('field_extra_fields', $bundle);
      drupal_alter('field_extra_fields', $extra, $bundle);

      // Add saved weights.
      foreach (variable_get("field_extra_weights_$bundle", array()) as $key => $value) {
        // Some stored entries might not exist anymore, for instance if uploads
        // have been disabled or vocabularies were deleted.
        if (isset($extra[$key])) {
          $extra[$key]['weight'] = $value;
        }
      }
      $info[$bundle] = $extra;
    }
  }
  if (array_key_exists($bundle_name, $info)) {
    return $info[$bundle_name];
  }
  else {
    return array();
  }
}

/**
 * Pre-render callback to adjust weights of non-field elements on objects.
 */
function _field_extra_weights_pre_render($elements) {
  if (isset($elements['#extra_fields'])) {
    foreach ($elements['#extra_fields'] as $key => $value) {
      // Some core 'fields' use a different key in node forms and in 'view'
      // render arrays. Ensure that we are not on a form first.
      if (!isset($elements['#build_id']) && isset($value['view']) && isset($elements[$value['view']])) {
        $elements[$value['view']]['#weight'] = $value['weight'];
      }
      elseif (isset($elements[$key])) {
        $elements[$key]['#weight'] = $value['weight'];
      }
    }
  }
  return $elements;
}

416
417
418
419
420
421
422
423
/**
 * Clear the cached information; called in several places when field
 * information is changed.
 */
function field_cache_clear($rebuild_schema = FALSE) {
  cache_clear_all('*', 'cache_field', TRUE);

  module_load_include('inc', 'field', 'field.info');
424
  _field_info_cache_clear();
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463

  // Refresh the schema to pick up new information.
  // TODO : if db storage gets abstracted out, we'll need to revisit how and when
  // we refresh the schema...
  if ($rebuild_schema) {
    $schema = drupal_get_schema(NULL, TRUE);
  }
}

/**
 * Like filter_xss_admin(), but with a shorter list of allowed tags.
 *
 * Used for items entered by administrators, like field descriptions,
 * allowed values, where some (mainly inline) mark-up may be desired
 * (so check_plain() is not acceptable).
 */
function field_filter_xss($string) {
  return filter_xss($string, _field_filter_xss_allowed_tags());
}

/**
 * List of tags allowed by field_filter_xss().
 */
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');
}

/**
 * Human-readable list of allowed tags, for display in help texts.
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
 * Format a field item for display.
 *
 * TODO D7 : do we still need field_format ?
 * - backwards compatibility of templates - check what fallbacks we can propose...
464
 * - was used by Views integration in CCK in D6 - do we need now?
465
466
467
468
469
470
471
472
473
474
475
476
 * At least needs a little rehaul/update...
 *
 * Used to display a field's values outside the context of the $node, as
 * when fields are displayed in Views, or to display a field in a template
 * using a different formatter than the one set up on the Display Fields tab
 * for the node's context.
 *
 * @param $field
 *   Either a field array or the name of the field.
 * @param $item
 *   The field item(s) to be formatted (such as $node->field_foo[0],
 *   or $node->field_foo if the formatter handles multiple values itself)
477
478
 * @param $formatter_type
 *   The name of the formatter type to use.
479
480
481
482
483
484
485
486
487
 * @param $node
 *   Optionally, the containing node object for context purposes and
 *   field-instance options.
 *
 * @return
 *   A string containing the contents of the field item(s) sanitized for display.
 *   It will have been passed through the necessary check_plain() or check_markup()
 *   functions as necessary.
 */
488
function field_format($obj_type, $object, $field, $item, $formatter_type = NULL, $formatter_settings = array()) {
489
490
491
492
493
  if (!is_array($field)) {
    $field = field_info_field($field);
  }

  if (field_access('view', $field)) {
494
495
496
    $field_type = field_info_field_types($field['type']);

    // We need $field, $instance, $obj_type, $object to be able to display a value...
497
498
499
500
    list(, , $bundle) = field_attach_extract_ids($obj_type, $object);
    $instance = field_info_instance($field['field_name'], $bundle);

    $display = array(
501
      'type' => $formatter_type ? $formatter_type : $field_type['default_formatter'],
502
503
      'settings' => $formatter_settings,
    );
504
505
506
    $display['settings'] += field_info_formatter_settings($display['type']);

    if ($display['type'] !== 'hidden') {
507
508
509
510
511
512
513
514
515
      $theme = $formatter['module'] . '_formatter_' . $display['type'];

      $element = array(
        '#theme' => $theme,
        '#field_name' => $field['field_name'],
        '#bundle' => $bundle,
        '#formatter' => $display['type'],
        '#settings' => $display['settings'],
        '#object' => $object,
516
        '#object_type' => $obj_type,
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
        '#delta' => isset($item['#delta']) ? $item['#delta'] : NULL,
      );

      if (field_behaviors_formatter('multiple values', $display) == FIELD_BEHAVIOR_DEFAULT) {
        // Single value formatter.

        // hook_field('sanitize') expects an array of items, so we build one.
        $items = array($item);
        $function = $field['module'] . '_field_sanitize';
        if (function_exists($function)) {
          $function($obj_type, $object, $field, $instance, $items);
        }

        $element['#item'] = $items[0];
      }
      else {
        // Multiple values formatter.
        $items = $item;
        $function = $field['module'] . '_field_sanitize';
        if (function_exists($function)) {
          $function($obj_type, $object, $field, $instance, $items);
        }

        foreach ($items as $delta => $item) {
          $element[$delta] = array(
            '#item' => $item,
            '#weight' => $delta,
          );
        }
      }

      return theme($theme, $element);
    }
  }
}

/**
554
 * Return a single field, fully themed with label and multiple values.
555
556
 *
 * To be used by third-party code (Views, Panels...) that needs to output
557
 * an isolated field. Do *not* use inside node templates, use
558
 * render($content[FIELD_NAME]) instead.
559
 *
560
561
562
 * The field will be displayed using the display options (label display,
 * formatter settings...) specified in the $instance structure for the given
 * build mode: $instance['display'][$build_mode].
563
564
565
566
 *
 * @param $object
 *   The object containing the field to display. Must at least contain the id key,
 *   revision key (if applicable), bundle key, and the field data.
567
568
569
570
 * @param $field
 *   The field structure.
 * @param $instance
 *   The instance structure for $field on $object's bundle.
571
572
 * @param $build_mode
 *   Build mode, e.g. 'full', 'teaser'...
573
574
575
 * @return
 *   The themed output for the field.
 */
576
function field_view_field($obj_type, $object, $field, $instance, $build_mode = 'full') {
577
578
579
580
581
582
  $output = '';
  if (isset($object->$field['field_name'])) {
    $items = $object->$field['field_name'];

    // One-field equivalent to _field_invoke('sanitize').
    $function = $field['module'] . '_field_sanitize';
583
    if (function_exists($function)) {
584
585
586
587
      $function($obj_type, $object, $field, $instance, $items);
      $object->$field['field_name'] = $items;
    }

588
    $view = field_default_view($obj_type, $object, $field, $instance, $items, $build_mode);
589
590
    // TODO : what about hook_field_attach_view ?

591
    $output = $view[$field['field_name']];
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
  }
  return $output;
}

/**
 * Determine whether the user has access to a given field.
 *
 * @param $op
 *   The operation to be performed. Possible values:
 *   - "edit"
 *   - "view"
 * @param $field
 *   The field on which the operation is to be performed.
 * @param $account
 *   (optional) The account to check, if not given use currently logged in user.
 * @return
 *   TRUE if the operation is allowed;
 *   FALSE if the operation is denied.
 */
function field_access($op, $field, $account = NULL) {
  global $user;

  if (is_null($account)) {
    $account = $user;
  }

  $field_access = module_invoke_all('field_access', $op, $field, $account);
  foreach ($field_access as $value) {
    if ($value === FALSE) {
      return FALSE;
    }
  }
  return TRUE;
}

/**
 * Theme preprocess function for field.tpl.php.
 *
 * @see field.tpl.php
 */
function template_preprocess_field(&$variables) {
  $element = $variables['element'];
  list(, , $bundle) = field_attach_extract_ids($element['#object_type'], $element['#object']);
  $instance = field_info_instance($element['#field_name'], $bundle);
  $field = field_info_field($element['#field_name']);

638
639
  $field_type_css = strtr($field['type'], '_', '-');
  $field_name_css = strtr($field['field_name'], '_', '-');
640

641
642
643
  // If the formatter is multiple, the template sees only one 'item', which
  // will include all values.
  $items = $element['#formatter_single'] ? $element['items'] : array($element['items']);
644
645

  $additions = array(
646
647
648
649
650
    'object' => $element['#object'],
    'field' => $field,
    'instance' => $instance,
    'build_mode' => $element['#build_mode'],
    'items' => $items,
651
652
    'field_type' => $field['type'],
    'field_name' => $field['field_name'],
653
654
655
    'field_type_css' => $field_type_css,
    'field_name_css' => $field_name_css,
    'label' => $element['#title'],
656
    'label_display' => $element['#label_display'],
657
    'label_hidden' => $element['#label_display'] == 'hidden',
658
659
    'field_language' => $element['#language'],
    'field_translatable' => $field['translatable'],
660
661
662
663
664
    'classes_array' => array(
      'field-name-' . $field_name_css,
      'field-type-' . $field_type_css,
      'field-label-' . $element['#label_display'],
    ),
665
666
667
668
669
670
671
672
673
674
675
676
    'template_files' => array(
      'field',
      'field-' . $element['#field_name'],
      'field-' . $bundle,
      'field-' . $element['#field_name'] . '-' . $bundle,
    ),
  );
  $variables = array_merge($variables, $additions);
}

/**
 * @} End of "defgroup field"
677
 */