Newer
Older
Angie Byron
committed
<?php
/**
* @file
* Attach custom data fields to Drupal entities.
Angie Byron
committed
*/
Dries Buytaert
committed
/**
* 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 {}
/*
Dries Buytaert
committed
* 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.
*/
Angie Byron
committed
require_once DRUPAL_ROOT . '/modules/field/field.crud.inc';
require_once DRUPAL_ROOT . '/modules/field/field.default.inc';
require_once DRUPAL_ROOT . '/modules/field/field.info.inc';
require_once DRUPAL_ROOT . '/modules/field/field.multilingual.inc';
require_once DRUPAL_ROOT . '/modules/field/field.attach.inc';
require_once DRUPAL_ROOT . '/modules/field/field.form.inc';
Angie Byron
committed
/**
* @defgroup field Field API
* @{
* Attach custom data fields to Drupal entities.
Angie Byron
committed
*
* 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
Angie Byron
committed
* 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
Angie Byron
committed
* data type, form element, and display format capabilities.
*
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
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
218
219
220
221
222
223
224
* 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'.
*
* Field definitions are represented as an array of key/value pairs.
*
* array $field:
* - id (integer, read-only)
* The primary identifier of the field. It is assigned automatically
* by field_create_field().
* - field_name (string)
* The name of the field. Each field name is unique 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.
* - type (string)
* The type of the field, such as 'text' or 'image'. Field types
* are defined by modules that implement hook_field_info().
* - 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 values are any
* positive integer or FIELD_CARDINALITY_UNLIMITED.
* - translatable (integer)
* Whether the field is translatable.
* - locked (integer)
* Whether or not the field is available for editing. If TRUE, users can't
* change field settings or create new instances of the field in the UI.
* Defaults to FALSE.
* - module (string, read-only)
* The name of the module that implements the field type.
* - active (integer, read-only)
* TRUE if the module that implements the field type is currently
* enabled, FALSE otherwise.
* - deleted (integer, read-only)
* TRUE if this field has been deleted, FALSE otherwise. Deleted
* fields are ignored by the Field Attach API. This 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 on
* the 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 definition format
* as Schema API index specifications. Only columns that appear in the
* 'columns' setting are allowed. Note that field types can specify
* default indexes, which can be modified or added to when
* creating a field.
* - foreign keys: (optional) An associative array of relations, using the same
* 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.
* - settings (array)
* A sub-array of key/value pairs of field-type-specific settings. Each
* field type module defines and documents its own field settings.
* - 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 are defined
* by modules that implement hook_field_storage_info().
* - module (string, read-only)
* The name of the module that implements the storage backend.
* - active (integer, read-only)
* TRUE if the module that implements the storage backend is currently
* enabled, FALSE otherwise.
* - settings (array)
* A sub-array of key/value pairs of settings. Each storage backend
* defines and documents its own settings.
*
* Field instance definitions are represented as an array of key/value pairs.
*
* array $instance:
* - 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 field_create_instance().
* - field_name (string)
* The name of the field attached to the bundle by this instance.
* - entity_type (string)
* The name of the entity type the instance is attached to.
* - 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 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().
* - default_value_function (string)
* The name of the function, if any, that will provide a default value.
* - default_value (array)
* If default_value_function is not set, then fixed values can be provided.
* - 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 instance
* settings. Each field type module defines and documents its own
* instance settings.
* - 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 types
* are defined by modules that implement hook_field_widget_info().
* - 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 in entity
* edit forms.
* - module (string, read-only)
* The name of the module that implements the widget type.
* - display (array)
* A sub-array of key/value pairs identifying the way field 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
* '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.
* - ...
* - other_mode
* - ...
*
* Bundles are represented by two strings, an entity type and a bundle name.
Angie Byron
committed
*
* - @link field_types Field Types API @endlink. Defines field types,
* widget types, and display formatters. Field modules use this API
Angie Byron
committed
* 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
Angie Byron
committed
* deletes fields, bundles (a.k.a. "content types"), and instances.
* Modules use this API, often in hook_install(), to create
* custom data structures.
Angie Byron
committed
*
* - @link field_attach Field Attach API @endlink. Connects entity
* types to the Field API. Field Attach API functions load, store,
Dries Buytaert
committed
* 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
Angie Byron
committed
* themselves fieldable.
*
* - @link field_info Field Info API @endlink. Exposes information
Angie Byron
committed
* 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
Angie Byron
committed
* default implementation, field_sql_storage.module, stores field data
* in the local SQL database.
*
Dries Buytaert
committed
* - @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
* multilingual support for the Field API.
Angie Byron
committed
*/
/**
* Value for field API indicating a field accepts an unlimited number of values.
Angie Byron
committed
*/
define('FIELD_CARDINALITY_UNLIMITED', -1);
/**
* Value for field API indicating a widget doesn't accept default values.
*
* @see hook_field_widget_info()
Angie Byron
committed
*/
define('FIELD_BEHAVIOR_NONE', 0x0001);
Angie Byron
committed
/**
* 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.
Angie Byron
committed
*/
define('FIELD_BEHAVIOR_DEFAULT', 0x0002);
Angie Byron
committed
/**
* Value for field API indicating a widget can receive several field values.
*
* @see hook_field_widget_info()
Angie Byron
committed
*/
define('FIELD_BEHAVIOR_CUSTOM', 0x0004);
/**
* Age argument for loading the most recent version of an entity's
Angie Byron
committed
* field data with field_attach_load().
*/
define('FIELD_LOAD_CURRENT', 'FIELD_LOAD_CURRENT');
Angie Byron
committed
/**
* Age argument for loading the version of an entity's field data
* specified in the entity with field_attach_load().
Angie Byron
committed
*/
define('FIELD_LOAD_REVISION', 'FIELD_LOAD_REVISION');
/**
* Exception class thrown by hook_field_update_forbid().
*/
class FieldUpdateForbiddenException extends FieldException {}
Angie Byron
committed
/**
Dries Buytaert
committed
* Implements hook_help().
Angie Byron
committed
*/
function field_help($path, $arg) {
switch ($path) {
case 'admin/help#field':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$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/handbook/modules/field')) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Enabling field types') . '</dt>';
Angie Byron
committed
$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')));
Angie Byron
committed
// 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>';
$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/7', '@sql-store' => url('admin/help/field_sql_storage'))) . '</dd>';
$output .= '</dl>';
Angie Byron
committed
return $output;
}
}
/**
Dries Buytaert
committed
* Implements hook_theme().
Angie Byron
committed
*/
function field_theme() {
Dries Buytaert
committed
return array(
Angie Byron
committed
'field' => array(
'render element' => 'element',
Angie Byron
committed
),
'field_multiple_value_form' => array(
'render element' => 'element',
Angie Byron
committed
),
);
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_cron().
Dries Buytaert
committed
*
* Purges some deleted Field API data, if any exists.
*/
function field_cron() {
Angie Byron
committed
field_sync_field_status();
Dries Buytaert
committed
$limit = variable_get('field_purge_batch_size', 10);
field_purge_batch($limit);
}
Angie Byron
committed
/**
Dries Buytaert
committed
* Implements hook_modules_uninstalled().
Angie Byron
committed
*/
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);
}
}
/**
Angie Byron
committed
* Implements hook_system_info_alter().
*
* Goes through a list of all modules that provide a field type, and makes them
* required if there are any active fields of that type.
Angie Byron
committed
*/
Angie Byron
committed
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
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')) {
$explanation = t('Field type(s) in use - see !link', array('!link' => l(t('Field list'), 'admin/reports/fields')));
}
else {
$explanation = t('Fields type(s) in use');
}
}
else {
$explanation = t('Fields pending deletion');
}
$info['explanation'] = $explanation;
}
Angie Byron
committed
}
}
/**
Angie Byron
committed
* Implements hook_flush_caches().
Angie Byron
committed
*/
Angie Byron
committed
function field_flush_caches() {
field_sync_field_status();
return array('cache_field');
}
/**
* 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.
$all_modules = system_rebuild_module_data();
$modules = array();
foreach ($all_modules as $module_name => $module) {
if ($module->status) {
$modules[] = $module_name;
field_associate_fields($module_name);
}
}
db_update('field_config')
->fields(array('active' => 0))
Angie Byron
committed
->condition('module', $modules, 'NOT IN')
->execute();
db_update('field_config')
->fields(array('storage_active' => 0))
Angie Byron
committed
->condition('storage_module', $modules, 'NOT IN')
->execute();
Angie Byron
committed
}
/**
* Allows a module to update the database for fields and columns it controls.
*
Angie Byron
committed
* @param $module
Angie Byron
committed
* The name of the module to update on.
*/
function field_associate_fields($module) {
Dries Buytaert
committed
// Associate field types.
Angie Byron
committed
$field_types = (array) module_invoke($module, 'field_info');
Dries Buytaert
committed
foreach ($field_types as $name => $field_info) {
db_update('field_config')
->fields(array('module' => $module, 'active' => 1))
->condition('type', $name)
->execute();
Angie Byron
committed
}
Dries Buytaert
committed
// Associate storage backends.
$storage_types = (array) module_invoke($module, 'field_storage_info');
foreach ($storage_types as $name => $storage_info) {
db_update('field_config')
->fields(array('storage_module' => $module, 'storage_active' => 1))
->condition('storage_type', $name)
->execute();
}
Angie Byron
committed
}
Angie Byron
committed
/**
* Helper function to get the default value for a field on an entity.
Angie Byron
committed
*
* @param $entity_type
Angie Byron
committed
* The type of $entity; e.g., 'node' or 'user'.
* @param $entity
* The entity for the operation.
Angie Byron
committed
* @param $field
* The field structure.
* @param $instance
* The instance structure.
Angie Byron
committed
* @param $langcode
* The field language to fill-in with the default value.
Angie Byron
committed
*/
function field_get_default_value($entity_type, $entity, $field, $instance, $langcode = NULL) {
Angie Byron
committed
$items = array();
if (!empty($instance['default_value_function'])) {
$function = $instance['default_value_function'];
if (function_exists($function)) {
$items = $function($entity_type, $entity, $field, $instance, $langcode);
Angie Byron
committed
}
}
elseif (!empty($instance['default_value'])) {
$items = $instance['default_value'];
}
return $items;
}
Angie Byron
committed
/**
Dries Buytaert
committed
* Helper function to filter out empty field values.
Angie Byron
committed
*
Dries Buytaert
committed
* @param $field
* The field definition.
* @param $items
* The field values to filter.
Angie Byron
committed
*
Dries Buytaert
committed
* @return
* The array of items without empty field values. The function also renumbers
* the array keys to ensure sequential deltas.
Angie Byron
committed
*/
Dries Buytaert
committed
function _field_filter_items($field, $items) {
Angie Byron
committed
$function = $field['module'] . '_field_is_empty';
function_exists($function);
Angie Byron
committed
foreach ((array) $items as $delta => $item) {
Dries Buytaert
committed
// Explicitly break if the function is undefined.
Angie Byron
committed
if ($function($item, $field)) {
unset($items[$delta]);
Angie Byron
committed
}
}
Angie Byron
committed
return array_values($items);
Angie Byron
committed
}
/**
* 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) ? $a['_weight'] : 0);
$b_weight = (is_array($b) ? $b['_weight'] : 0);
return $a_weight - $b_weight;
Angie Byron
committed
}
/**
* 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);
return $a_weight - $b_weight;
Angie Byron
committed
}
Angie Byron
committed
/**
Dries Buytaert
committed
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
* Gets or sets administratively defined bundle settings.
*
* For each bundle, settings are provided as a nested array with the following
* structure:
* @code
* array(
* 'view_modes' => array(
* // One sub-array per view mode for the entity type:
* 'full' => array(
* 'custom_display' => Whether the view mode uses custom display
* settings or settings of the 'default' mode,
* ),
* 'teaser' => ...
* ),
* 'extra_fields' => array(
* 'form' => array(
* // One sub-array per pseudo-field in displayed entities:
* 'extra_field_1' => array(
* 'weight' => The weight of the pseudo-field,
* ),
* 'extra_field_2' => ...
* ),
* 'display' => array(
* // One sub-array per pseudo-field in displayed entities:
* 'extra_field_1' => array(
* // One sub-array per view mode for the entity type, including
* // the 'default' mode:
* 'default' => array(
* 'weight' => The weight of the pseudo-field,
Dries Buytaert
committed
* 'visible' => TRUE if the pseudo-field is visible, FALSE if hidden,
Dries Buytaert
committed
* ),
* 'full' => ...
* ),
* 'extra_field_2' => ...
* ),
* ),
* );
Dries Buytaert
committed
* @endcode
Angie Byron
committed
*
* @param $entity_type
Angie Byron
committed
* The type of $entity; e.g., 'node' or 'user'.
Angie Byron
committed
* The bundle name.
Dries Buytaert
committed
* @param $settings
* (optional) The settings to store.
*
* @return
* If no $settings are passed, the current settings are returned.
*/
function field_bundle_settings($entity_type, $bundle, $settings = NULL) {
$stored_settings = variable_get('field_bundle_settings', array());
if (isset($settings)) {
$stored_settings[$entity_type][$bundle] = $settings;
Dries Buytaert
committed
variable_set('field_bundle_settings', $stored_settings);
Dries Buytaert
committed
field_info_cache_clear();
Dries Buytaert
committed
}
else {
$settings = isset($stored_settings[$entity_type][$bundle]) ? $stored_settings[$entity_type][$bundle] : array();
$settings += array(
'view_modes' => array(),
'extra_fields' => array(),
);
$settings['extra_fields'] += array(
'form' => array(),
'display' => array(),
);
Dries Buytaert
committed
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
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
// definition in hook_entity_info() specify they should use custom settings
// by default.
$entity_info = entity_get_info($entity_type);
foreach ($entity_info['view modes'] as $view_mode => $view_mode_info) {
if (!isset($settings[$view_mode]['custom_settings']) && $view_mode_info['custom settings']) {
$settings[$view_mode]['custom_settings'] = TRUE;
}
}
$cache[$entity_type][$bundle] = $settings;
}
return $cache[$entity_type][$bundle];
}
/**
* Returns the display settings to use for an instance in a given view mode.
*
* @param $instance
* The field instance being displayed.
* @param $view_mode
* The view mode.
Dries Buytaert
committed
* @param $entity
* The entity being displayed.
Dries Buytaert
committed
*
* @return
* The display settings to be used when displaying the field values.
*/
Dries Buytaert
committed
function field_get_display($instance, $view_mode, $entity) {
Dries Buytaert
committed
// Check whether the view mode uses custom display settings or the 'default'
// mode.
$view_mode_settings = field_view_mode_settings($instance['entity_type'], $instance['bundle']);
$actual_mode = (!empty($view_mode_settings[$view_mode]['custom_settings']) ? $view_mode : 'default');
$display = $instance['display'][$actual_mode];
// Let modules alter the display settings.
$context = array(
'entity_type' => $instance['entity_type'],
'field' => field_info_field($instance['field_name']),
'instance' => $instance,
Dries Buytaert
committed
'entity' => $entity,
Dries Buytaert
committed
'view_mode' => $view_mode,
);
drupal_alter(array('field_display', 'field_display_' . $instance['entity_type']), $display, $context);
return $display;
Dries Buytaert
committed
* Returns the display settings to use for pseudo-fields in a given view mode.
* @param $entity_type
Angie Byron
committed
* The type of $entity; e.g., 'node' or 'user'.
* @param $bundle
* The bundle name.
Dries Buytaert
committed
* @param $view_mode
* The view mode.
*
Dries Buytaert
committed
* The display settings to be used when viewing the bundle's pseudo-fields.
*/
function field_extra_fields_get_display($entity_type, $bundle, $view_mode) {
// Check whether the view mode uses custom display settings or the 'default'
// mode.
$view_mode_settings = field_view_mode_settings($entity_type, $bundle);
$actual_mode = (!empty($view_mode_settings[$view_mode]['custom_settings'])) ? $view_mode : 'default';
Dries Buytaert
committed
$extra_fields = field_info_extra_fields($entity_type, $bundle, 'display');
Dries Buytaert
committed
$displays = array();
foreach ($extra_fields as $name => $value) {
$displays[$name] = $extra_fields[$name]['display'][$actual_mode];
Angie Byron
committed
}
Dries Buytaert
committed
// Let modules alter the display settings.
$context = array(
'entity_type' => $entity_type,
'bundle' => $bundle,
'view_mode' => $view_mode,
);
drupal_alter('field_extra_fields_display', $displays, $context);
return $displays;
Angie Byron
committed
}
/**
Dries Buytaert
committed
* Pre-render callback to adjust weights and visibility of non-field elements.
Angie Byron
committed
*/
Dries Buytaert
committed
function _field_extra_fields_pre_render($elements) {
$entity_type = $elements['#entity_type'];
$bundle = $elements['#bundle'];
if (isset($elements['#type']) && $elements['#type'] == 'form') {
Dries Buytaert
committed
$extra_fields = field_info_extra_fields($entity_type, $bundle, 'form');
Dries Buytaert
committed
foreach ($extra_fields as $name => $settings) {
if (isset($elements[$name])) {
$elements[$name]['#weight'] = $settings['weight'];
Angie Byron
committed
}
Dries Buytaert
committed
}
}
elseif (isset($elements['#view_mode'])) {
$view_mode = $elements['#view_mode'];
$extra_fields = field_extra_fields_get_display($entity_type, $bundle, $view_mode);
foreach ($extra_fields as $name => $settings) {
if (isset($elements[$name])) {
$elements[$name]['#weight'] = $settings['weight'];
// Visibility: make sure we do not accidentally show a hidden element.
$elements[$name]['#access'] = isset($elements[$name]['#access']) ? ($elements[$name]['#access'] && $settings['visible']) : $settings['visible'];
Angie Byron
committed
}
}
}
Dries Buytaert
committed
Angie Byron
committed
return $elements;
}
Angie Byron
committed
/**
* Clear the field info and field data caches.
Angie Byron
committed
*/
function field_cache_clear() {
Angie Byron
committed
cache_clear_all('*', 'cache_field', TRUE);
Dries Buytaert
committed
field_info_cache_clear();
Angie Byron
committed
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
}
/**
* 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()) . '>';
}
/**
Dries Buytaert
committed
* Returns a renderable array for a single field value.
Angie Byron
committed
*
Dries Buytaert
committed
* @param $entity_type
Angie Byron
committed
* The type of $entity; e.g., 'node' or 'user'.
Dries Buytaert
committed
* @param $entity
* The entity containing the field to display. Must at least contain the id
* key and the field data to display.
* @param $field_name
* The name of the field to display.
Angie Byron
committed
* @param $item
Dries Buytaert
committed
* The field value to display, as found in
* $entity->field_name[$langcode][$delta].
* @param $display
* Can be either the name of a view mode, or an array of display settings.
* See field_view_field() for more information.
* @param $langcode
* (Optional) The language of the value in $item. If not provided, the
* current language will be assumed.
Angie Byron
committed
* @return
Dries Buytaert
committed
* A renderable array for the field value.
Angie Byron
committed
*/
Dries Buytaert
committed
function field_view_value($entity_type, $entity, $field_name, $item, $display = array(), $langcode = NULL) {
$output = array();
Angie Byron
committed
Dries Buytaert
committed
if ($field = field_info_field($field_name)) {
// Determine the langcode that will be used by language fallback.
Dries Buytaert
committed
$langcode = field_language($entity_type, $entity, $field_name, $langcode);
Angie Byron
committed
Dries Buytaert
committed
// 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);
$elements = field_view_field($entity_type, $clone, $field_name, $display, $langcode);
Angie Byron
committed
Dries Buytaert
committed
// Extract the part of the render array we need.
$output = isset($elements[0]) ? $elements[0] : array();
if (isset($elements['#access'])) {
$output['#access'] = $elements['#access'];
Angie Byron
committed
}
}
Dries Buytaert
committed
return $output;
Angie Byron
committed
}
/**
* Returns a renderable array for the value of a single field in an entity.
Angie Byron
committed
*
* The resulting output is a fully themed field with label and multiple values.
Angie Byron
committed
*
* 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.
* - Do not use to display all fields in an entity, use
* field_attach_prepare_view() and field_attach_view() instead.
* - The field_view_value() function can be used to output a single formatted
* field value, without label or wrapping field markup.
Angie Byron
committed
*
* The function takes care of invoking the prepare_view steps. It also respects
* field access permissions.
*
* @param $entity_type
Angie Byron
committed
* The type of $entity; e.g., 'node' or 'user'.
* @param $entity
* The entity containing the field to display. Must at least contain the id
* key and the field data to display.
* @param $field_name
* The name of the field to display.
* @param $display
* Can be either:
* - The name of a view mode. The field will be displayed according to the
* display settings specified for this view mode in the $instance
* definition for the field in the entity's bundle.
* If no display settings are found for the view mode, the settings for
Dries Buytaert
committed
* the 'default' view mode will be used.
* - An array of display settings, as found in the 'display' entry of
Dries Buytaert
committed
* $instance definitions. The following key/value pairs are allowed:
* - 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
* '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.
* - settings: (array) Settings specific to the formatter. Defaults to the
* formatter's default settings, specified in
* hook_field_formatter_info().
* - weight: (float) The weight to assign to the renderable element.
* Defaults to 0.
* @param $langcode
* (Optional) The language the field values are to be shown in. The site's
* current language fallback logic will be applied no values are available
* for the language. If no language is provided the current language will be
* used.
Angie Byron
committed
* @return
* A renderable array for the field value.
*
* @see field_view_value()
Angie Byron
committed
*/
function field_view_field($entity_type, $entity, $field_name, $display = array(), $langcode = NULL) {
$output = array();
Angie Byron
committed
if ($field = field_info_field($field_name)) {
if (is_array($display)) {
// When using custom display settings, fill in default values.
$display = _field_info_prepare_instance_display($field, $display);
}
Angie Byron
committed
// Hook invocations are done through the _field_invoke() functions in
// 'single field' mode, to reuse the language fallback logic.
Dries Buytaert
committed
// Determine the actual language to display for the field, given the
// languages available in the field data.
$display_language = field_language($entity_type, $entity, $field_name, $langcode);
$options = array('field_name' => $field_name, 'language' => $display_language);
$null = NULL;
Dries Buytaert
committed
// Invoke prepare_view steps if needed.
if (empty($entity->_field_view_prepared)) {
list($id) = entity_extract_ids($entity_type, $entity);
// First let the field types do their preparation.
_field_invoke_multiple('prepare_view', $entity_type, array($id => $entity), $display, $null, $options);
// Then let the formatters do their own specific massaging.
_field_invoke_multiple_default('prepare_view', $entity_type, array($id => $entity), $display, $null, $options);
}
// Build the renderable array.
$result = _field_invoke_default('view', $entity_type, $entity, $display, $null, $options);
Dries Buytaert
committed
// 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_type' => $entity_type,
'entity' => $entity,
'view_mode' => '_custom',
'display' => $display,
);
drupal_alter('field_attach_view', $result, $context);
Angie Byron
committed
if (isset($result[$field_name])) {
$output = $result[$field_name];
}
Angie Byron
committed
}
Angie Byron
committed
return $output;
}
Dries Buytaert
committed
/**
* Returns the field items in the language they currently would be displayed.
*
* @param $entity_type
Angie Byron
committed
* The type of $entity; e.g., 'node' or 'user'.
Dries Buytaert
committed
* @param $entity
* 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.
*/
function field_get_items($entity_type, $entity, $field_name, $langcode = NULL) {
$langcode = field_language($entity_type, $entity, $field_name, $langcode);
return isset($entity->{$field_name}[$langcode]) ? $entity->{$field_name}[$langcode] : FALSE;
}
/**
* Determine whether a field has any data.
*
* @param $field
* A field structure.
* @return
* TRUE if the field has data for any entity; FALSE otherwise.
*/
function field_has_data($field) {
$query = new EntityFieldQuery();
return (bool) $query
->fieldCondition($field)
->range(0, 1)
->count()
->execute();
}
Angie Byron
committed
/**
* 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 $entity_type
Angie Byron
committed
* The type of $entity; e.g., 'node' or 'user'.