191 lines
6.6 KiB
PHP
191 lines
6.6 KiB
PHP
<?php
|
|
// $Id$
|
|
|
|
/**
|
|
* @file
|
|
* Default 'implementations' of hook_field_*(): common field housekeeping.
|
|
*
|
|
* Those implementations are special, as field.module does not define any field
|
|
* types. Those functions take care of default stuff common to all field types.
|
|
* They are called through the _field_invoke_default() iterator, generally in
|
|
* the corresponding field_attach_[operation]() function.
|
|
*/
|
|
|
|
function field_default_extract_form_values($obj_type, $object, $field, $instance, &$items, $form, &$form_state) {
|
|
$field_name = $field['field_name'];
|
|
|
|
if (isset($form_state['values'][$field_name])) {
|
|
$items = $form_state['values'][$field_name];
|
|
// Remove the 'value' of the 'add more' button.
|
|
unset($items[$field_name . '_add_more']);
|
|
}
|
|
}
|
|
|
|
function field_default_validate($obj_type, $object, $field, $instance, $items) {
|
|
// TODO: here we could validate that required fields are filled in (for programmatic save)
|
|
}
|
|
|
|
function field_default_submit($obj_type, $object, $field, $instance, &$items, $form, &$form_state) {
|
|
$field_name = $field['field_name'];
|
|
|
|
// TODO: should me move what's below to __extract_form_values ?
|
|
|
|
// Reorder items to account for drag-n-drop reordering.
|
|
if (field_behaviors_widget('multiple values', $instance) == FIELD_BEHAVIOR_DEFAULT) {
|
|
$items = _field_sort_items($field, $items);
|
|
}
|
|
|
|
// Filter out empty values.
|
|
$items = field_set_empty($field, $items);
|
|
}
|
|
|
|
/**
|
|
* Default field 'insert' operation.
|
|
*
|
|
* Insert default value if no $object->$field_name entry was provided.
|
|
* This can happen with programmatic saves, or on form-based creation where
|
|
* the current user doesn't have 'edit' permission for the field.
|
|
*/
|
|
function field_default_insert($obj_type, $object, $field, $instance, &$items) {
|
|
// _field_invoke() populates $items with an empty array if the $object has no
|
|
// entry for the field, so we check on the $object itself.
|
|
if (!property_exists($object, $field['field_name']) && !empty($instance['default_value_function'])) {
|
|
$function = $instance['default_value_function'];
|
|
if (drupal_function_exists($function)) {
|
|
$items = $function($obj_type, $object, $field, $instance);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* The 'view' operation constructs the $object in a way that you can use
|
|
* drupal_render() to display the formatted output for an individual field.
|
|
* i.e. print drupal_render($object->content['field_foo']);
|
|
*
|
|
* The code supports both single value formatters, which theme an individual
|
|
* item value, and multiple value formatters, which theme all values for the
|
|
* field in a single theme. The multiple value formatters could be used, for
|
|
* instance, to plot field values on a single map or display them in a graph.
|
|
* Single value formatters are the default, multiple value formatters can be
|
|
* designated as such in formatter_info().
|
|
*
|
|
* The $object array will look like:
|
|
* $object->content['field_foo'] = array(
|
|
* '#theme' => 'field',
|
|
* '#title' => 'label'
|
|
* '#field_name' => 'field_name',
|
|
* '#object' => $object,
|
|
* '#object_type' => $obj_type,
|
|
* // Value of the $build_mode param of hook_node('view').
|
|
* '#build_mode' => $build_mode,
|
|
* 'items' =>
|
|
* 0 => array(
|
|
* '#item' => $items[0],
|
|
* // Only for 'single-value' formatters
|
|
* '#theme' => $theme,
|
|
* '#field_name' => 'field_name',
|
|
* '#bundle' => $bundle,
|
|
* '#formatter' => $formatter_name,
|
|
* '#settings' => $formatter_settings,
|
|
* '#object' => $object,
|
|
* '#object_type' => $obj_type,
|
|
* '#delta' => 0,
|
|
* ),
|
|
* 1 => array(
|
|
* '#item' => $items[1],
|
|
* // Only for 'single-value' formatters
|
|
* '#theme' => $theme,
|
|
* '#field_name' => 'field_name',
|
|
* '#bundle' => $bundle_name,
|
|
* '#formatter' => $formatter_name,
|
|
* '#settings' => $formatter_settings,
|
|
* '#object' => $object,
|
|
* '#object_type' => $obj_type,
|
|
* '#delta' => 1,
|
|
* ),
|
|
* // Only for 'multiple-value' formatters
|
|
* '#theme' => $theme,
|
|
* '#field_name' => 'field_name',
|
|
* '#bundle' => $bundle_name,
|
|
* '#formatter' => $formatter_name,
|
|
* '#settings' => $formatter_settings,
|
|
* ),
|
|
* );
|
|
*/
|
|
function field_default_view($obj_type, $object, $field, $instance, $items, $build_mode) {
|
|
list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $object);
|
|
|
|
$addition = array();
|
|
|
|
// If we don't have specific settings for the current build_mode, we use the
|
|
// (required) 'full' build_mode.
|
|
$display = isset($instance['display'][$build_mode]) ? $instance['display'][$build_mode] : $instance['display']['full'];
|
|
// Ensure we have a valid formatter and formatter settings.
|
|
$display = _field_get_formatter($display, $field);
|
|
|
|
if ($display['type'] && $display['type'] !== 'hidden') {
|
|
$theme = 'field_formatter_' . $display['type'];
|
|
$single = (field_behaviors_formatter('multiple values', $display) == FIELD_BEHAVIOR_DEFAULT);
|
|
|
|
$label_display = $display['label'];
|
|
if ($build_mode == 'search_index') {
|
|
$label_display = 'hidden';
|
|
}
|
|
|
|
$info = array(
|
|
'#field_name' => $field['field_name'],
|
|
'#bundle' => $bundle,
|
|
'#object' => $object,
|
|
'#object_type' => $obj_type,
|
|
);
|
|
|
|
$element = $info + array(
|
|
'#theme' => 'field',
|
|
'#weight' => $instance['weight'],
|
|
'#title' => check_plain(t($instance['label'])),
|
|
'#access' => field_access('view', $field),
|
|
'#label_display' => $label_display,
|
|
'#build_mode' => $build_mode,
|
|
'#single' => $single,
|
|
'items' => array(),
|
|
);
|
|
|
|
// Fill-in items.
|
|
foreach ($items as $delta => $item) {
|
|
$element['items'][$delta] = array(
|
|
'#item' => $item,
|
|
'#weight' => $delta,
|
|
);
|
|
}
|
|
|
|
// Append formatter information either on each item ('single-value' formatter)
|
|
// or at the upper 'items' level ('multiple-value' formatter)
|
|
$format_info = $info + array(
|
|
'#formatter' => $display['type'],
|
|
'#settings' => $display['settings'],
|
|
'#theme' => $theme,
|
|
);
|
|
|
|
if ($single) {
|
|
foreach ($items as $delta => $item) {
|
|
$element['items'][$delta] += $format_info;
|
|
$element['items'][$delta]['#item']['#delta'] = $delta;
|
|
}
|
|
}
|
|
else {
|
|
$element['items'] += $format_info;
|
|
}
|
|
|
|
$addition = array($field['field_name'] => $element);
|
|
}
|
|
return $addition;
|
|
}
|
|
|
|
function field_default_prepare_translation($obj_type, $object, $field, $instance, &$items) {
|
|
$addition = array();
|
|
if (isset($object->translation_source->$field['field_name'])) {
|
|
$addition[$field['field_name']] = $object->translation_source->$field['field_name'];
|
|
}
|
|
return $addition;
|
|
}
|