=== modified file 'includes/form.inc'
--- includes/form.inc 2009-01-12 07:00:09 +0000
+++ includes/form.inc 2009-01-15 16:50:15 +0000
@@ -920,8 +920,10 @@
// after normal input parsing has been completed.
if (isset($form['#after_build']) && !isset($form['#after_build_done'])) {
foreach ($form['#after_build'] as $function) {
- $form = $function($form, $form_state);
- $form['#after_build_done'] = TRUE;
+ if (drupal_function_exists($function)) {
+ $form = $function($form, $form_state);
+ $form['#after_build_done'] = TRUE;
+ }
}
}
=== modified file 'includes/install.inc'
--- includes/install.inc 2009-01-04 19:00:08 +0000
+++ includes/install.inc 2009-01-15 16:50:16 +0000
@@ -490,8 +490,10 @@
*
* @param $module_list
* The modules to install.
+ * @param $disable_modules_installed_hook
+ * Normally just testing wants to set this to TRUE.
*/
-function drupal_install_modules($module_list = array()) {
+function drupal_install_modules($module_list = array(), $disable_modules_installed_hook = FALSE) {
$files = module_rebuild_cache();
$module_list = array_flip(array_values($module_list));
do {
@@ -511,7 +513,7 @@
asort($module_list);
$module_list = array_keys($module_list);
$modules_installed = array_filter($module_list, '_drupal_install_module');
- if (!empty($modules_installed)) {
+ if (!$disable_modules_installed_hook && !empty($modules_installed)) {
module_invoke_all('modules_installed', $modules_installed);
}
module_enable($module_list);
=== modified file 'includes/module.inc'
--- includes/module.inc 2009-01-14 13:00:07 +0000
+++ includes/module.inc 2009-01-15 16:50:53 +0000
@@ -267,7 +267,7 @@
// Force to regenerate the stored list of hook implementations.
registry_rebuild();
}
-
+
foreach ($invoke_modules as $module) {
module_invoke($module, 'enable');
// Check if node_access table needs rebuilding.
@@ -427,7 +427,6 @@
}
$loaded[$hook] = TRUE;
}
-
if ($sort) {
if (!isset($sorted_implementations[$hook])) {
$sorted_implementations[$hook] = $implementations[$hook];
=== modified file 'includes/theme.inc'
--- includes/theme.inc 2009-01-11 22:00:08 +0000
+++ includes/theme.inc 2009-01-15 16:50:16 +0000
@@ -2010,7 +2010,11 @@
}
// Clean up name so there are no underscores.
$variables['template_files'][] = 'node-' . str_replace('_', '-', $node->type);
- $variables['template_files'][] = 'node-' . $node->nid;
+ $variables['template_files'][] = 'node-' . $node->nid;
+
+ // Add $FIELD_NAME_rendered variables for fields.
+ drupal_function_exists('field_attach_preprocess');
+ $variables += field_attach_preprocess('node', $node);
}
/**
=== added directory 'modules/field'
=== added file 'modules/field/D6 - D7 API changes.txt'
--- modules/field/D6 - D7 API changes.txt 1970-01-01 00:00:00 +0000
+++ modules/field/D6 - D7 API changes.txt 2009-01-15 16:50:15 +0000
@@ -0,0 +1,59 @@
+- content_types() -> field_info_*();
+- content_fields() -> field_info_*()
+- _content_field_types() -> field_info_field_types()
+ _content_widget_types() -> field_info_widget_types()
+- conntent_view_field() -> field_view_field(), with new signature
+- hook_field_info(), hook_widget_info(), hook_field_formatter_info():
+ hook_field_info() needs to specify default widget and formatters
+ new format for 'behaviors'
+ names of widget types and formatters need to be prefixed with the module name to avoid name clashes.
+- pattern for formatter theme functions has changed
+- hook_default_value() -> hook_widget_default_value()
+
+hook comparison: D7 D6 Remarks
+-----------------------------------------------------------------------------------------------------------------------------
+hook_field_info() unchanged
+hook_field_columns($field) hook_field_settings('database columns') defines 'data pins' in SQL-lingo
+hook_field_settings($field_type) hook_field_settings('save') also returns default values for the settings - move into hook_field_info() ?
+hook_field_settings_form($field) hook_field_settings('form') only for UI
+hook_field_settings_form_validate($field) hook_field_settings('validate') only for UI + fully deprecate in favor of regular FAPI validation ?
+hook_field_is_empty($item, $field) unchanged Unlike other hook_field_*(), this operatates on a single value ($item, not $items)
+Previous hook_field() $op :
+hook_field_validate($obj_type, $object, $field, $instance, $items, $form)
+hook_field_presave($obj_type, $object, $field, $instance, $items) Use cases ?
+hook_field_load($obj_type, $object, $field, $instance, $items)
+hook_field_insert($obj_type, $object, $field, $instance, $items)
+hook_field_update($obj_type, $object, $field, $instance, $items)
+hook_field_delete($obj_type, $object, $field, $instance, $items)
+hook_field_delete_revision($obj_type, $object, $field, $instance, $items)
+hook_field_prepare_translation($obj_type, $object, $field, $instance, $items)
+hook_field_sanitize($obj_type, $object, $field, $instance, $items) Typically operates on single values, like hook_field_is_empty().
+
+hook_field_instance_settings($field_type) - also returns default values for the settings - move into hook_field_info() ?
+hook_field_instance_settings_form($instance) - only for UI
+hook_field_instance_settings_form_validate($instance) - only for UI + fully deprecate for regular FAPI validation ?
+
+hook_widget_info() unchanged
+hook_widget_settings($widget_type) hook_widget_settings('save') also returns default values for the settings - move into hook_widget_info() ?
+hook_widget_settings_form($instance) hook_widget_settings('form') only for UI
+hook_widget_settings_form_validate($instance) hook_widget_settings('validate') only for UI + fully deprecate in favor of regular FAPI validation ?
+hook_widget() unchanged return FAPI element
+hook_widget_default_value() hook_default_value() Signature looks strange
+
+hook_field_formatter_info() unchanged
+hook_field_formatter_settings($formatter_type) - also returns default values for the settings - move into hook_field_formatter_info() ?
+
+hook_field(): D6 $op hook_field_*() Default implementation
+--------------------------------------------------------------------------
+'validate' x x (currently unused)
+'presave' x (use cases ?) x
+'load' x - (content_storage)
+'insert' x - (content_storage)
+'update' x - (content_storage)
+'delete' x - (content_storage)
+'delete revision' x - (content_storage)
+'prepare translation' x (noderef uses it) x
+'view' - x
+'preprocess_node' - x
+
+'sanitize' x -
=== added file 'modules/field/field.attach.inc'
--- modules/field/field.attach.inc 1970-01-01 00:00:00 +0000
+++ modules/field/field.attach.inc 2009-01-15 16:50:15 +0000
@@ -0,0 +1,365 @@
+data as $key => $value) {
+ $obj->$key = $value;
+ }
+ }
+ else {
+ $queried_objs[$id] = $objects[$id];
+ }
+ }
+ // Fetch other nodes from the database.
+ if ($queried_objs) {
+ // We need the raw additions to be able to cache them, so
+ // content_storage_load() and hook_field_load() must not alter
+ // nodes directly but return their additions.
+ $additions = module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'load', $obj_type, $queried_objs, $age);
+ foreach ($additions as $id => $obj_additions) {
+ foreach ($obj_additions as $key => $value) {
+ $queried_objs[$id]->$key = $value;
+ }
+ }
+
+ // TODO D7 : to be consistent we might want to make hook_field_load() accept
+ // multiple objects too. Which forbids going through _field_invoke(), but
+ // requires manually iterating the instances instead.
+ foreach ($queried_objs as $id => $object) {
+ $custom_additions = _field_invoke('load', $obj_type, $object);
+ foreach ($custom_additions as $key => $value) {
+ $queried_objs[$id]->$key = $value;
+ $additions[$id][$key] = $value;
+ }
+
+ // Let other modules act on loading the object.
+ foreach (module_implements('field_attach_load') as $module) {
+ $function = $module .'_field_attach_load';
+ $function($obj_type, $queried_objs[$id]);
+ }
+
+ // Cache the data.
+ list($id, $vid, $bundle, $cacheable) = field_attach_extract_ids($obj_type, $obj);
+ if ($cacheable) {
+ $cid = "field:$obj_type:$id:$vid";
+ $data = isset($additions[$id]) ? $additions[$id] : array();
+ cache_set($cid, $data, 'cache_field');
+ }
+ }
+ }
+}
+
+/**
+ * Load all fields for a previous version of each of a set of
+ * objects of a single object type.
+ *
+ * @param $obj_type
+ * The type of objects for which to load fields; e.g. 'node' or
+ * 'user'.
+ * @param $objects
+ * An array of objects for which to load fields. The keys for
+ * primary id, revision id, and bundle name to load are identified by
+ * hook_fieldable_info for $obj_type.
+ * @returns
+ * On return, the objects in $objects are modified by having the
+ * appropriate set of fields added.
+ */
+function _field_attach_load_revision($obj_type, $objects) {
+ return field_attach_load($obj_type, $objects, FIELD_LOAD_REVISION);
+}
+
+/**
+ *
+ */
+function _field_attach_validate($obj_type, &$object, $form = NULL) {
+ _field_invoke('validate', $obj_type, $object, $form);
+ _field_invoke_default('validate', $obj_type, $object, $form);
+
+ // Let other modules validate the object.
+ foreach (module_implements('field_attach_validate') as $module) {
+ $function = $module .'_field_attach_validate';
+ $function($obj_type, $object, $form);
+ }
+}
+
+/**
+ * Accounts for d-n-d reordering of field values.
+ * TODO D7 : rename to 'field_attach_submit' ?
+ */
+function _field_attach_presave($obj_type, &$object) {
+ _field_invoke('presave', $obj_type, $object);
+ _field_invoke_default('presave', $obj_type, $object);
+
+ // Let other modules act on presaving the object.
+ foreach (module_implements('field_attach_presave') as $module) {
+ $function = $module .'_field_attach_presave';
+ $function($obj_type, $object);
+ }
+}
+
+/**
+ *
+ */
+function _field_attach_insert($obj_type, &$object) {
+ _field_invoke('insert', $obj_type, $object);
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'write', $obj_type, $object);
+
+ // Let other modules act on inserting the object.
+ foreach (module_implements('field_attach_insert') as $module) {
+ $function = $module .'_field_attach_insert';
+ $function($obj_type, $object);
+ }
+
+ list($id, $vid, $bundle, $cacheable) = field_attach_extract_ids($obj_type, $object);
+ if ($cacheable) {
+ cache_clear_all("field:$obj_type:$id:", 'cache_field', TRUE);
+ }
+}
+
+/**
+ *
+ */
+function _field_attach_update($obj_type, &$object) {
+ _field_invoke('update', $obj_type, $object);
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'write', $obj_type, $object, TRUE);
+
+ // Let other modules act on updating the object.
+ foreach (module_implements('field_attach_update') as $module) {
+ $function = $module .'_field_attach_update';
+ $function($output, $obj_type, $object);
+ }
+
+ list($id, $vid, $bundle, $cacheable) = field_attach_extract_ids($obj_type, $object);
+ if ($cacheable) {
+ cache_clear_all("field:$obj_type:$id:$vid", 'cache_field');
+ }
+}
+
+/**
+ *
+ */
+function _field_attach_delete($obj_type, &$object) {
+ _field_invoke('delete', $obj_type, $object);
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'delete', $obj_type, $object);
+
+ // Let other modules act on deleting the object.
+ foreach (module_implements('field_attach_delete') as $module) {
+ $function = $module .'_field_attach_delete';
+ $function($obj_type, $object);
+ }
+
+ list($id, $vid, $bundle, $cacheable) = field_attach_extract_ids($obj_type, $object);
+ if ($cacheable) {
+ cache_clear_all("field:$obj_type:$id:", 'cache_field', TRUE);
+ }
+}
+
+/**
+ *
+ */
+function _field_attach_delete_revision($obj_type, &$object) {
+ _field_invoke('delete revision', $obj_type, $object);
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'delete_revision', $obj_type, $object);
+
+ // Let other modules act on deleting the revision.
+ foreach (module_implements('field_attach_delete_revision') as $module) {
+ $function = $module .'_field_attach_delete_revision';
+ $function($obj_type, $object);
+ }
+
+ list($id, $vid, $bundle, $cacheable) = field_attach_extract_ids($obj_type, $object);
+ if ($cacheable) {
+ cache_clear_all("field:$obj_type:$id:$vid", 'cache_field');
+ }
+}
+
+/**
+ *
+ */
+function _field_attach_view($obj_type, &$object, $teaser = FALSE, $page = FALSE) {
+ // Let field modules sanitize their data for output.
+ _field_invoke('sanitize', $obj_type, $object);
+
+ $output = _field_invoke_default('view', $obj_type, $object, $teaser, $page);
+
+ // Let other modules make changes after rendering the view.
+ foreach (module_implements('field_attach_view') as $module) {
+ $function = $module .'_field_attach_view';
+ $function($output, $obj_type, $object, $teaser, $page);
+ }
+
+ return $output;
+
+}
+
+/**
+ * To be called in entity preprocessor.
+ *
+ * - Adds $FIELD_NAME_rendered variables
+ * containing the themed output for the whole field.
+ * - Adds the formatted values in the 'view' key of the items.
+ */
+function _field_attach_preprocess($obj_type, &$object) {
+ return _field_invoke_default('preprocess', $obj_type, $object);
+}
+
+/**
+ * Implementation of hook_nodeapi_prepare_translation.
+ */
+function _field_attach_prepare_translation(&$node) {
+ // Prevent against invalid 'nodes' built by broken 3rd party code.
+ if (isset($node->type)) {
+ $type = content_types($node->type);
+ // Save cycles if the type has no fields.
+ if (!empty($type['instances'])) {
+ $default_additions = _field_invoke_default('prepare translation', $node);
+ $additions = _field_invoke('prepare translation', $node);
+ // Merge module additions after the default ones to enable overriding
+ // of field values.
+ $node = (object) array_merge((array) $node, $default_additions, $additions);
+ }
+ }
+}
+
+/**
+ * Notify field.module that a new bundle was created.
+ *
+ * The default SQL-based storage doesn't need to do anytrhing about it, but
+ * others might.
+ *
+ * @param $bundle
+ * The name of the newly created bundle.
+ */
+function _field_attach_create_bundle($bundle) {
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'create_bundle', $bundle);
+
+ // Clear the cache.
+ field_cache_clear();
+
+ foreach (module_implements('field_attach_create_bundle') as $module) {
+ $function = $module .'_field_attach_create_bundle';
+ $function($bundle);
+ }
+}
+
+/**
+ * Notify field.module that a bundle was renamed.
+ *
+ * @param $bundle_old
+ * The previous name of the bundle.
+ * @param $bundle_new
+ * The new name of the bundle.
+ */
+function _field_attach_rename_bundle($bundle_old, $bundle_new) {
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'rename_bundle', $bundle_old, $bundle_new);
+ db_update('field_config_instance')
+ ->fields(array('bundle' => $bundle_new))
+ ->condition('bundle', $bundle_old)
+ ->execute();
+
+ // Clear the cache.
+ field_cache_clear();
+
+ foreach (module_implements('field_attach_rename_bundle') as $module) {
+ $function = $module .'_field_attach_rename_bundle';
+ $function($bundle_old, $bundle_new);
+ }
+}
+
+/**
+ * Notify field.module the a bundle was deleted.
+ *
+ * This deletes the data for the field instances as well as the field instances
+ * themselves. This function actually just marks the data and field instances
+ * and deleted, leaving the garbage collection for a separate process, because
+ * it is not always possible to delete this much data in a single page request
+ * (particularly since for some field types, the deletion is more than just a
+ * simple DELETE query).
+ *
+ * @param $bundle
+ * The bundle to delete.
+ */
+function _field_attach_delete_bundle($bundle) {
+ // Let other modules act on deleting the bundle
+ foreach (module_implements('field_attach_delete_bundle') as $module) {
+ $function = $module .'_field_attach_delete_bundle';
+ $function($bundle);
+ }
+
+ // Delete the instances themseves
+ $instances = field_info_instances($bundle);
+ foreach ($instances as $instance) {
+ field_delete_instance($instance['field_name'], $bundle);
+ }
+}
+
+/**
+ * Helper function to extract id, vid, and bundle name from an object.
+ *
+ * Made public so that it can be used by modules implementing
+ * hook_field_attach_op().
+ */
+function _field_attach_extract_ids($object_type, $object) {
+ // TODO D7 : prevent against broken 3rd party $node without 'type'.
+ $info = field_info_fieldable_types($object_type);
+ // Objects being created might not have id/vid yet.
+ $id = isset($object->{$info['id key']}) ? $object->{$info['id key']} : NULL;
+ $vid = ($info['revision key'] && isset($object->{$info['revision key']})) ? $object->{$info['revision key']} : NULL;
+ // If no bundle key provided, then we assume a single bundle, named after the
+ // type of the object.
+ $bundle = $info['bundle key'] ? $object->{$info['bundle key']} : $object_type;
+ $cacheable = isset($info['cacheable']) ? $info['cacheable'] : FALSE;
+ return array($id, $vid, $bundle, $cacheable);
+}
=== added file 'modules/field/field.autoload.inc'
--- modules/field/field.autoload.inc 1970-01-01 00:00:00 +0000
+++ modules/field/field.autoload.inc 2009-01-15 16:50:15 +0000
@@ -0,0 +1,225 @@
+ $field['type'])));
+ }
+
+ // Ensure the field name is unique. We also check disabled or deleted fields.
+ // TODO : do we want specific messages when clashing with a disabled or inactive field ?
+ $prior_field = field_read_field($field['field_name'], array('include_inactive' => TRUE, 'include_deleted' => TRUE));
+ if (!empty($prior_field)) {
+ throw new FieldException(t('Attempt to create field name %name which already exists.', array('%name' => $field['field_name'])));
+ }
+
+ $field += array(
+ 'cardinality' => 1,
+ 'locked' => FALSE,
+ 'settings' => array(),
+ );
+ $module = $field_type['module'];
+ // Create all per-field-type properties (needed here as long as we have
+ // settings that impact column definitions).
+ $field['settings'] += field_info_field_settings($field['type']);
+ $field['module'] = $module;
+ $field['active'] = 1;
+ $field['deleted'] = 0;
+ // Create the data table. We need to populate the field columns, even though
+ // we don't actually store them.
+ $field['columns'] = _field_columns($field);
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'create_table', $field);
+
+ drupal_write_record('field_config', $field);
+
+ // Clear caches
+ field_cache_clear(TRUE);
+}
+
+function field_read_field($field_name, $include_additional = array()) {
+ $fields = field_read_fields(array('field_name' => $field_name), $include_additional);
+ return $fields ? current($fields) : FALSE;
+}
+
+/**
+ * Read in fields that match an array of conditions.
+ *
+ * @params
+ * An array of conditions to match against.
+ * @include_additional
+ * The default behavior of this function is to not return fields that
+ * are inactive or have been deleted. Setting $include_additional['include_inactive']
+ * or $include_additional['include_deleted'] will override this behavior.
+ */
+function field_read_fields($params = array(), $include_additional = array()) {
+ $query = db_select('field_config', 'fc', array('fetch' => PDO::FETCH_ASSOC));
+ $query->fields('fc');
+
+ // Turn the conditions into a query.
+ foreach ($params as $key => $value) {
+ $query->condition($key, $value);
+ }
+ if (!isset($include_additional['include_inactive']) || !$include_additional['include_inactive']) {
+ $query->condition('fc.active', 1);
+ }
+ if (!isset($include_additional['include_deleted']) || !$include_additional['include_deleted']) {
+ $query->condition('fc.deleted', 0);
+ }
+
+ $fields = array();
+ $results = $query->execute();
+ foreach ($results as $field) {
+ // drupal_write_record() writes an empty string for empty arrays.
+ $field['settings'] = $field['settings'] ? unserialize($field['settings']) : array();
+
+ module_invoke_all('field_read_field', $field);
+
+ // Populate storage columns.
+ $field['columns'] = _field_columns($field);
+
+
+ $fields[$field['field_name']] = $field;
+ }
+ return $fields;
+}
+
+/**
+ * Mark a field for deletion, including all its instances and all data
+ * associated with it.
+ */
+function field_delete_field($field_name) {
+ // Mark the field for deletion.
+ db_update('field_config')
+ ->fields(array('deleted' => 1))
+ ->condition('field_name', $field_name)
+ ->execute();
+
+ // Mark any instances of the field for deletion.
+ db_update('field_config_instance')
+ ->fields(array('deleted' => 1))
+ ->condition('field_name', $field_name)
+ ->execute();
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'delete_table', $field_name);
+ // Clear the cache.
+ field_cache_clear(TRUE);
+}
+
+/**
+ * Populate the storage columns for a field.
+ */
+function _field_columns($field) {
+ $columns = (array) module_invoke($field['module'], 'field_columns', $field);
+ // Actual column name : prefix with field name.
+ foreach($columns as $column_name => $attributes) {
+ $columns[$column_name]['column'] = $field['field_name'] . '_' . $column_name;
+ }
+ return $columns;
+}
+
+/**
+ * Creates an instance of a field, binding it to a bundle.
+ * @param $instance
+ * An associative array represeting an instance structure. Keys and values:
+ * field_name: The name of the field.
+ * bundle: The bundle this field belongs to. (For eg. node_story)
+ * label: The human-readable name for this instance.
+ * description: A description of what this instance holds.
+ * weight: The weight for this instance, used by the Form API
+ * representation, view rendering, etc.
+ * settings: Array of instance-specific properties (e.g. whether a
+ * user-reference shows as a backreference on userpages, or allowed
+ * file extensions on an update field).
+ * widget: An associative array storing the edit widget and its settings.
+ * type: The widget type (e.g. text_textfield or text_textarea).
+ * @TODO: cleanup from this point.
+ * Internal properties:
+ * $module: The module that defines the widget type.
+ * $active: Whether $module is enabled.
+ * $deleted: Always set to 0. Indicates that the field instance is not
+ * marked for deletion.
+ * $settings: Per-widget-type settings (e.g. rows for text_textarea).
+ * public $display: An array mapping display context names to
+ * public $display_settings: An array mapping display context names to
+ * properties. The properties can include:
+ * 'label': How the label should be displayed when this field is
+ * rendered: 'above', 'inline', 'hidden'.
+ * 'formatter': TODO.
+ * 'exclude': Whether to omit this field value from the rendered content.
+ * public $default_value. TODO: DEFINE.
+ * public $default_value_php. TODO: DEFINE.
+ *
+ ** Internal properties. These are protected if possible.
+ * public $widget_active;
+ * protected $field;
+ * protected $_field_name;
+ * protected $widget_class = 'WidgetSettings';
+ */
+function field_create_instance($instance) {
+ // Check that the specified field exists.
+ $field = field_read_field($instance['field_name']);
+ if (empty($field)) {
+ throw new FieldException("Attempt to create an instance of a field that doesn't exist.");
+ }
+
+ // TODO: Check that the specifed bundle exists.
+
+ // TODO: Check that the widget type is known and can handle the field type ?
+ // TODO: Check that the formatters are known and can handle the field type ?
+ // TODO: Check that the display build modes are known for the object type ?
+ // Those checks should probably happen in _field_write_instance() ?
+ // Problem : this would mean that CCK cannot update an instance with a disabled formatter.
+
+ // Ensure the field instance is unique.
+ // TODO : do we want specific messages when clashing with a disabled or inactive instance ?
+ $prior_instance = field_read_instance($instance['field_name'], $instance['bundle'], array('include_inactive' => TRUE, 'include_deleted' => TRUE));
+ if (!empty($prior_instance)) {
+ throw new FieldException('Attempt to create a field instance which already exists.');
+ }
+
+ _field_write_instance($instance);
+
+ // Clear caches
+ field_cache_clear();
+ return FALSE;
+}
+
+/*
+ * Update an instance of a field.
+ *
+ * @param $instance
+ * An associative array represeting an instance structure. The required
+ * keys and values are:
+ * field_name: The name of an existing field.
+ * bundle: The bundle this field belongs to.
+ *
+ * @see field_create_instance()
+ */
+function field_update_instance($instance) {
+ // Check that the specified field exists.
+ $field = field_read_field($instance['field_name']);
+ if (empty($field)) {
+ throw new FieldException("Attempt to update an instance of a nonexistent field.");
+ }
+
+ // Check that the field instance exists (even if it is inactive, since we
+ // want to be able to replace inactive widgets with new ones).
+ $prior_instance = field_read_instance($instance['field_name'], $instance['bundle'], array('include_inactive' => TRUE));
+ if (empty($prior_instance)) {
+ throw new FieldException("Attempt to update a field instance that doesn't exist.");
+ }
+
+ _field_write_instance($instance, TRUE);
+
+ // Clear caches.
+ field_cache_clear();
+}
+
+function _field_write_instance($instance, $update = FALSE) {
+ $field = field_read_field($instance['field_name']);
+ $field_type = field_info_field_types($field['type']);
+
+ // Set defaults.
+ $instance += array(
+ 'settings' => array(),
+ 'display' => array(),
+ 'widget' => array(),
+ 'required' => FALSE,
+ 'label' => $instance['field_name'],
+ 'description' => '',
+ 'weight' => 0,
+ 'deleted' => 0,
+ );
+
+ // Set default instance settings.
+ $instance['settings'] += field_info_instance_settings($field['type']);
+
+ // Set default widget and settings.
+ $instance['widget'] += array(
+ // TODO: what if no 'default_widget' specified ?
+ 'type' => $field_type['default_widget'],
+ 'settings' => array(),
+ );
+ // Check widget module.
+ $widget_type = field_info_widget_types($instance['widget']['type']);
+ $widget_module = $widget_type['module'];
+ $widget_active = module_exists($widget_module);
+ $instance['widget']['settings'] += field_info_widget_settings($instance['widget']['type']);
+ $instance['widget']['module'] = $widget_module;
+ $instance['widget']['active'] = $widget_active;
+
+ // Make sure there is at least display info for the 'full' context.
+ $instance['display'] += array(
+ 'full' => array(),
+ );
+ // Set default display settings for each context.
+ foreach ($instance['display'] as $context => $display) {
+ $instance['display'][$context] += array(
+ 'label' => 'above',
+ 'exclude' => 0,
+ // TODO: what if no 'default_formatter' specified ?
+ 'type' => $field_type['default_formatter'],
+ 'settings' => array(),
+ );
+ $formatter_type = field_info_formatter_types($instance['display'][$context]['type']);
+ // TODO : 'hidden' will raise PHP warnings.
+ $instance['display'][$context]['module'] = $formatter_type['module'];
+ $instance['display'][$context]['settings'] += field_info_formatter_settings($instance['display'][$context]['type']);
+ }
+
+ // Create $data to contain everything from $instance that does not
+ // have its own column, and thus will be stored serialized.
+ $data = $instance;
+ unset($data['field_name'], $data['bundle'], $data['widget']['type'], $data['weight'], $data['deleted']);
+
+ $record = array(
+ 'field_name' => $instance['field_name'],
+ 'bundle' => $instance['bundle'],
+ 'widget_type' => $instance['widget']['type'],
+ 'widget_module' => $widget_module,
+ 'widget_active' => $widget_active,
+ 'weight' => $instance['weight'],
+ 'data' => $data,
+ 'deleted' => $instance['deleted'],
+ );
+ // We need to tell drupal_update_record() the primary keys to trigger an
+ // update.
+ $primary_keys = $update ? array('field_name', 'bundle') : array();
+ drupal_write_record('field_config_instance', $record, $primary_keys);
+}
+
+function field_read_instance($field_name, $bundle, $include_additional = array()) {
+ $instances = field_read_instances(array('field_name' => $field_name, 'bundle' => $bundle), $include_additional);
+ return $instances ? current($instances) : FALSE;
+}
+
+/**
+ * Load a field instance.
+ *
+ * @param $param
+ * An array of properties to use in selecting a field instance. Valid keys:
+ * - 'bundle' - The name of the bundle (i.e. content type) in which the instance exists.
+ * - 'field_name' - The name of the field whose instance is to be loaded.
+ * if NULL, all instances will be returned.
+ * @param $include_additional
+ * The default behavior of this function is to not return field instances that
+ * are inactive or have been marked deleted. Setting $include_additional['include_inactive']
+ * or $include_additional['include_deleted'] will override this behavior.
+ * @return
+ * The field arrays.
+ */
+function field_read_instances($params = array(), $include_additional = array()) {
+ $query = db_select('field_config_instance', 'fci', array('fetch' => PDO::FETCH_ASSOC));
+ $query->join('field_config', 'fc', 'fc.field_name = fci.field_name');
+ $query->fields('fci');
+ #$query->fields('fc', array('type'));
+
+ // Turn the conditions into a query.
+ foreach ($params as $key => $value) {
+ $query->condition('fci.'.$key, $value);
+ }
+ $query->condition('fc.active', 1);
+ if (!isset($include_additional['include_inactive']) || !$include_additional['include_inactive']) {
+ $query->condition('fci.widget_active', 1);
+ }
+ if (!isset($include_additional['include_deleted']) || !$include_additional['include_deleted']) {
+ $query->condition('fc.deleted', 0);
+ $query->condition('fci.deleted', 0);
+ }
+
+ $instances = array();
+ $results = $query->execute();
+
+ foreach ($results as $record) {
+ $instance = unserialize($record['data']);
+ $instance['field_name'] = $record['field_name'];
+ $instance['bundle'] = $record['bundle'];
+ $instance['weight'] = $record['weight'];
+ $instance['deleted'] = $record['deleted'];
+ $instance['widget']['type'] = $record['widget_type'];
+ $instance['widget']['module'] = $record['widget_module'];
+ $instance['widget']['active'] = $record['widget_active'];
+
+ // TODO D7 : Set default widget settings, default instance settings, default display settings.
+ // (the modules that defined them might have changed since the instance was last saved).
+
+ module_invoke_all('field_read_instance', $instance);
+ $instances[] = $instance;
+ }
+ return $instances;
+}
+
+/**
+ * Mark a field instance for deletion, including all data associated with
+ * it.
+ *
+ * @param $field_name
+ * The name of the field whose instance will be deleted.
+ * @param $bundle
+ * The bundle for the instance which will be deleted.
+ */
+function field_delete_instance($field_name, $bundle) {
+ // Mark the field instance for deletion.
+ db_update('field_config_instance')
+ ->fields(array('deleted' => 1))
+ ->condition('field_name', $field_name)
+ ->condition('bundle', $bundle)
+ ->execute();
+
+ // Mark all data associated with the field for deletion.
+ module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'delete_instance', $field_name, $bundle);
+ // Clear the cache.
+ field_cache_clear();
+}
+
+/**
+ * @} End of "defgroup field_crud".
+ */
\ No newline at end of file
=== added file 'modules/field/field.default.inc'
--- modules/field/field.default.inc 1970-01-01 00:00:00 +0000
+++ modules/field/field.default.inc 2009-01-15 16:50:16 +0000
@@ -0,0 +1,271 @@
+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']['wrapper'] = array(
+ * '#type' => 'field',
+ * '#title' => 'label'
+ * '#field_name' => 'field_name',
+ * '#object' => $object,
+ * '#object_type' => $obj_type,
+ * // Value of the $teaser param of hook_nodeapi('view').
+ * '#teaser' => $teaser,
+ * '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_field_view($obj_type, $object, $field, $instance, $items, $teaser) {
+ list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $object);
+
+ $addition = array();
+
+ // Entities without build modes should provide a 'full' context.
+ // NODE_BUILD_NORMAL is 0, and ('whatever' == 0) is TRUE, so we need a ===.
+ if (!isset($object->build_mode)) {
+ $context = 'full';
+ }
+ elseif ($object->build_mode === NODE_BUILD_NORMAL
+ || $object->build_mode == NODE_BUILD_PREVIEW) {
+ $context = $teaser ? 'teaser' : 'full';
+ }
+ else {
+ $context = $object->build_mode;
+ }
+
+ // If we don't have specific settings for the current build_nmode, we use the
+ // (required) 'full' build_mode.
+ $display = isset($instance['display'][$context]) ? $instance['display'][$context] : $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 (isset($object->build_mode) && $object->build_mode == NODE_BUILD_SEARCH_INDEX) {
+ $label_display = 'hidden';
+ }
+
+ $info = array(
+ '#field_name' => $field['field_name'],
+ '#bundle' => $bundle,
+ '#object' => $object,
+ '#object_type' => $obj_type,
+ );
+
+ $element = $info + array(
+ '#type' => 'field',
+ '#title' => check_plain(t($instance['label'])),
+ '#access' => field_access('view', $field),
+ '#label_display' => $label_display,
+ '#teaser' => $teaser,
+ '#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;
+ }
+
+ // The wrapper lets us get the themed output for the whole field
+ // to populate the $FIELD_NAME_rendered variable for templates,
+ // and hide it from the $content variable if needed.
+ // See 'preprocess' op and theme_content_field_wrapper()?
+ $wrapper = $info + array(
+ 'field' => $element,
+ '#weight' => $instance['weight'],
+ '#post_render' => array('field_wrapper_post_render'),
+ '#context' => $context,
+ );
+
+ $addition = array($field['field_name'] => $wrapper);
+ }
+ return $addition;
+}
+
+/**
+ * Hide excluded fields from the $content variable in templates.
+ */
+function field_wrapper_post_render($content, $element) {
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ if (theme('field_exclude', $content, $instance, $element['#context'])) {
+ return '';
+ }
+ return $content;
+}
+
+/**
+ * 'Theme' function for a field's addition to the combined template output,
+ * i.e. the node's $content or the user's $user_profile value.
+ * This allows more flexibility in templates : you can use custom markup
+ * around a few specific fields, and print the rest normally.
+ *
+ * This is a theme function, so it can be overridden in different
+ * themes to produce different results.
+ *
+ * The html for individual fields and groups are available in the
+ * $FIELD_NAME_rendered and $GROUP_NAME_rendered variables.
+ *
+ * @return
+ * Whether or not the field's content is to be added in this context.
+ * Uses the 'exclude' value from the field's display settings.
+ */
+function theme_field_exclude($content, $object, $context) {
+ if (empty($object['display'])
+ || empty($object['display'][$context])
+ || empty($object['display'][$context]['exclude'])) {
+ return FALSE;
+ }
+ else {
+ return TRUE;
+ }
+}
+
+function field_field_preprocess($obj_type, $object, $field, $instance, &$items) {
+ return array(
+ $field['field_name'] .'_rendered' => isset($object->content[$field['field_name']]['#children']) ? $object->content[$field['field_name']]['#children'] : '',
+ );
+}
+
+function field_field_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;
+}
+
+/**
+ * Helper function to return the correct default value for a field.
+ *
+ * @param $object
+ * The object.
+ * @param $field
+ * The field array.
+ * @param $items
+ * The value of the field in the node.
+ * @return
+ * The default value for that field.
+ */
+// TODO D7: [yched] I really don't get the signature of this function - &$form, &$form_state ??
+// Karen, does it ring a bell for you ?
+// [Karen] It is called from field_field_form() and the parameter order matches
+// the D6 parameters that content_field_form() received -- it passes the
+// same parameters it receives on to the field modules in the same order.
+// I'm altering it to match the new parameters in field_field_form().
+// [yched] The new order of arguments definitely makes sense.
+// What I don't get is why we pass $form and $form_state: the only goal of the function is to return
+// a default '$items' sructure, not a partial form array. $items structure are form and widget agnostic.
+// The fact that we then use this default $items in a form (field_field_form()) is just incidental;
+// conceptually we should be able to ask "what is the default $items value of this field" from a non form context.
+// I wonder what info would be needed from $form or $form_state that's not already available in $obj_type, $object,
+// $field, $instance ?
+function field_widget_default_value($obj_type, $object, $field, $instance, &$form, &$form_state, $delta) {
+ $default_value = array();
+ if (!empty($instance['widget']['default_value_php'])) {
+ ob_start();
+ $result = eval($instance['widget']['default_value_php']);
+ ob_end_clean();
+ if (is_array($result)) {
+ $default_value = $result;
+ }
+ }
+ elseif (!empty($instance['widget']['default_value'])) {
+ $default_value = $instance['widget']['default_value'];
+ }
+ return (array) $default_value;
+}
\ No newline at end of file
=== added file 'modules/field/field.info'
--- modules/field/field.info 1970-01-01 00:00:00 +0000
+++ modules/field/field.info 2009-01-15 16:50:15 +0000
@@ -0,0 +1,13 @@
+; $Id$
+name = Field
+description = Field API to add fields to objects like nodes and users.
+package = Core - fields
+core = 7.x
+files[] = field.module
+files[] = field.install
+files[] = field.crud.inc
+files[] = field.default.inc
+files[] = field.attach.inc
+files[] = field.node_form.inc
+files[] = field.autoload.inc
+dependencies[] = field_sql_storage
=== added file 'modules/field/field.install'
--- modules/field/field.install 1970-01-01 00:00:00 +0000
+++ modules/field/field.install 2009-01-15 16:50:15 +0000
@@ -0,0 +1,153 @@
+ array(
+ 'field_name' => array(
+ 'type' => 'varchar',
+ 'length' => 32,
+ 'not null' => TRUE,
+ 'description' => 'The name of this field',
+ ),
+ 'type' => array(
+ 'type' => 'varchar',
+ 'length' => 128,
+ 'not null' => TRUE,
+ 'description' => 'The type of this field, coming from a field module',
+ ),
+ 'locked' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ 'description' => '@TODO',
+ ),
+ 'settings' => array(
+ 'type' => 'text',
+ 'size' => 'medium',
+ 'not null' => TRUE,
+ 'serialize' => TRUE,
+ 'description' => 'Field specific settings, for example maximum length',
+ ),
+ 'module' => array(
+ 'type' => 'varchar',
+ 'length' => 128,
+ 'not null' => TRUE,
+ 'default' => '',
+ ),
+ 'cardinality' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'active' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'deleted' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ ),
+ 'primary key' => array('field_name'),
+ 'indexes' => array(
+ // used by field_read_fields
+ 'active_deleted' => array('active', 'deleted'),
+ // used by field_modules_disabled
+ 'module' => array('module'),
+ // used by field_associate_fields
+ 'type' => array('type'),
+ ),
+ );
+ $schema['field_config_instance'] = array(
+ 'fields' => array(
+ 'field_name' => array('type' => 'varchar', 'length' => 32, 'not null' => TRUE, 'default' => ''),
+ 'bundle' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''),
+ 'widget_type' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''),
+ 'widget_module' => array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''),
+ 'widget_active' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'data' => array(
+ 'type' => 'text',
+ 'size' => 'medium',
+ 'not null' => TRUE,
+ 'serialize' => TRUE,
+ ),
+ 'weight' => array(
+ 'type' => 'int',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ 'deleted' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ ),
+ ),
+ 'primary key' => array('field_name', 'bundle'),
+ 'indexes' => array(
+ // used by field_read_instances
+ 'widget_active_deleted' => array('widget_active', 'deleted'),
+ // used by field_modules_disabled
+ 'widget_module' => array('widget_module'),
+ // used by field_associate_fields
+ 'widget_type' => array('widget_type'),
+ ),
+ );
+ $schema['cache_field'] = drupal_get_schema_unprocessed('system', 'cache');
+
+ return $schema;
+}
=== added file 'modules/field/field.module'
--- modules/field/field.module 1970-01-01 00:00:00 +0000
+++ modules/field/field.module 2009-01-15 16:50:16 +0000
@@ -0,0 +1,1138 @@
+ 'field_add_more_js',
+ 'access arguments' => array('access content'),
+ 'type' => MENU_CALLBACK,
+ );
+
+ return $items;
+}
+
+/**
+ * Implementation of hook elements().
+ */
+function field_elements() {
+ return array(
+ 'field' => array(),
+ );
+}
+
+/**
+ * Implementation of hook_theme().
+ */
+function field_theme() {
+ $path = drupal_get_path('module', 'field') .'/theme';
+
+ return array(
+ 'field' => array(
+ 'template' => 'field',
+ 'arguments' => array('element' => NULL),
+ 'path' => $path,
+ ),
+ // TODO D7 : do we need that in core ?
+ // Probably no easy way for a contrib module to do this
+ // since the Field module creates and processes the template,
+ // so maybe it must be in core. In core for now.
+ // [yched]: This is just adding
+ // '#post_render' => array('field_wrapper_post_render')
+ // at the right places in the render array generated by field_field_view().
+ // Can be done in hook_field_attach_post_view if we want.
+ 'field_exclude' => array(
+ 'arguments' => array('content' => NULL, 'object' => array(), 'context' => NULL),
+ ),
+ 'field_multiple_value_form' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_modules_installed().
+ */
+function field_modules_installed($modules) {
+ field_cache_clear();
+}
+
+/**
+ * Implementation of hook_modules_uninstalled().
+ */
+function field_modules_uninstalled($modules) {
+ module_load_include('inc', 'field', 'field.crud');
+ foreach ($modules as $module) {
+ field_module_delete($module);
+ }
+}
+
+/**
+ * Implementation of hook_modules_enabled().
+ */
+function field_modules_enabled($modules) {
+ foreach ($modules as $module) {
+ field_associate_fields($module);
+ }
+ field_cache_clear();
+}
+
+/**
+ * Implementation of hook_modules_disabled().
+ */
+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();
+ }
+ }
+}
+
+/**
+ * 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
+ */
+function field_set_empty($field, $items) {
+ // Filter out empty values.
+ $filtered = array();
+ $function = $field['module'] .'_field_is_empty';
+ foreach ((array) $items as $delta => $item) {
+ if (!$function($item, $field)) {
+ $filtered[] = $item;
+ }
+ }
+ return $filtered;
+}
+
+/**
+ * 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;
+}
+
+/**
+ * Invoke a field hook.
+ *
+ * @param $op
+ * - Possible operations include:
+ * - load
+ * - form
+ * - validate
+ * - presave
+ * - insert
+ * - update
+ * - delete
+ * - delete revision
+ * - sanitize
+ * - view
+ * - preprocess
+ * - prepare translation
+ *
+ * @param $obj_type
+ * - Can be:
+ * - node
+ * - user
+ * - Others not yet implemented.
+ *
+ * @param $object
+ * - The fully formed $obj_type object.
+ *
+ * @param $a
+ * - The $form in the 'form' operation.
+ * - The value of $teaser in the 'view' operation.
+ * - Otherwise NULL.
+ *
+ * @param $b
+ * - The value of $page in the 'view' operation.
+ * - Otherwise NULL.
+ *
+ * @param $default
+ * - TRUE: render the default field implementation of the field hook.
+ * - FALSE: render the field module's implementation of the field hook.
+ */
+function _field_invoke($op, $obj_type, &$object, &$a = NULL, &$b = NULL, $default = FALSE) {
+ list(, , $bundle) = field_attach_extract_ids($obj_type, $object);
+ $instances = field_info_instances($bundle);
+
+ $return = array();
+ foreach ($instances as $instance) {
+ $field_name = $instance['field_name'];
+ $field = field_info_field($field_name);
+ $items = isset($object->$field_name) ? $object->$field_name : array();
+
+ // Make sure AHAH 'add more' button isn't sent to the fields for processing.
+ // TODO D7 : needed ?
+ unset($items[$field_name .'_add_more']);
+
+ $function = $default ? 'field_field_'. $op : $field['module'] .'_field_'. $op;
+ if (drupal_function_exists($function)) {
+ $result = $function($obj_type, $object, $field, $instance, $items, $a, $b);
+ if (is_array($result)) {
+ $return = array_merge($return, $result);
+ }
+ else if (isset($result)) {
+ $return[] = $result;
+ }
+ }
+ // test for values in $items in case modules added items on insert
+ if (isset($object->$field_name) || count($items)) {
+ $object->$field_name = $items;
+ }
+ }
+
+ return $return;
+}
+
+/**
+ * Invoke field.module's version of a field hook.
+ */
+function _field_invoke_default($op, $obj_type, &$object, &$a = NULL, &$b = NULL) {
+ return _field_invoke($op, $obj_type, $object, $a, $b, TRUE);
+}
+
+
+/**
+ * Helper function for determining the behavior of a field
+ * with respect to a given operation.
+ *
+ * @param $op
+ * The name of the operation.
+ * Currently supported : none
+ * // TODO D7: no use cases (yet ?) - do we want to keep that function ?.
+ * @param $field
+ * The field array.
+ * @return
+ * FIELD_BEHAVIOR_NONE - do nothing for this operation.
+ * FIELD_BEHAVIOR_CUSTOM - use the field's callback function.
+ * FIELD_BEHAVIOR_DEFAULT - use field.module default behavior.
+ */
+function field_behaviors_field($op, $field) {
+ $info = field_info_field_types($field['type']);
+ return isset($info['behaviors'][$op]) ? $info['behaviors'][$op] : FIELD_BEHAVIOR_DEFAULT;
+}
+
+/**
+ * Helper function for determining the behavior of a widget
+ * with respect to a given operation.
+ *
+ * @param $op
+ * The name of the operation.
+ * Currently supported: 'default value', 'multiple values'.
+ * @param $instance
+ * The field instance array.
+ * @return
+ * FIELD_BEHAVIOR_NONE - do nothing for this operation.
+ * FIELD_BEHAVIOR_CUSTOM - use the widget's callback function.
+ * FIELD_BEHAVIOR_DEFAULT - use field.module default behavior.
+ */
+function field_behaviors_widget($op, $instance) {
+ $info = field_info_widget_types($instance['widget']['type']);
+ return isset($info['behaviors'][$op]) ? $info['behaviors'][$op] : FIELD_BEHAVIOR_DEFAULT;
+}
+
+/**
+ * Helper function for determining the behavior of a formatter
+ * with respect to a given operation.
+ *
+ * @param $op
+ * The name of the operation.
+ * Currently supported: 'multiple values'
+ * @param $display
+ * The $instance['display'][$build_mode] array.
+ * @return
+ * FIELD_BEHAVIOR_NONE - do nothing for this operation.
+ * FIELD_BEHAVIOR_CUSTOM - use the formatter's callback function.
+ * FIELD_BEHAVIOR_DEFAULT - use field module default behavior.
+ */
+function field_behaviors_formatter($op, $display) {
+ $info = field_info_formatter_types($display['type']);
+ return isset($info['behaviors'][$op]) ? $info['behaviors'][$op] : FIELD_BEHAVIOR_DEFAULT;
+}
+
+/**
+ * Return hook_field_info() data.
+ *
+ * @param $field_type
+ * (optional) A field type name. If ommitted, all field types will be
+ * returned.
+ * @return
+ * Either a field type description, as provided by hook_field_info(), or an
+ * array of all existing field types, keyed by field type name.
+ */
+function field_info_field_types($field_type = NULL) {
+ $info = _field_info_types();
+ $field_types = $info['field types'];
+ if ($field_type) {
+ if (isset($field_types[$field_type])) {
+ return $field_types[$field_type];
+ }
+ }
+ else {
+ return $field_types;
+ }
+}
+
+/**
+ * Return hook_field_widget_info() data.
+ *
+ * @param $widget_type
+ * (optional) A widget type name. If ommitted, all widget types will be
+ * returned.
+ * @return
+ * Either a widget type description, as provided by
+ * hook_field_widget_info(), or an array of all existing widget
+ * types, keyed by widget type name.
+ */
+function field_info_widget_types($widget_type = NULL) {
+ $info = _field_info_types();
+ $widget_types = $info['widget types'];
+ if ($widget_type) {
+ if (isset($widget_types[$widget_type])) {
+ return $widget_types[$widget_type];
+ }
+ }
+ else {
+ return $widget_types;
+ }
+}
+
+/**
+ * Return hook_field_formatter_info() data.
+ *
+ * @param $formatter_type
+ * (optional) A formatter type name. If ommitted, all formatter types will be
+ * returned.
+ * @return
+ * Either a formatter type description, as provided by hook_field_formatter_info(),
+ * or an array of all existing widget types, keyed by widget type name.
+ */
+function field_info_formatter_types($formatter_type = NULL) {
+ $info = _field_info_types();
+ $formatter_types = $info['formatter types'];
+ if ($formatter_type) {
+ if (isset($formatter_types[$formatter_type])) {
+ return $formatter_types[$formatter_type];
+ }
+ }
+ else {
+ return $formatter_types;
+ }
+}
+
+/**
+ * Return hook_fieldable_info() data.
+ *
+ * @param $obj_type
+ * (optional) A fieldable type name. If ommitted, all fieldable types will be
+ * returned.
+ * @return
+ * Either a fieldable type description, as provided by hook_fieldable_info(),
+ * or an array of all existing fieldable types, keyed by fieldable type name.
+ */
+function field_info_fieldable_types($obj_type = NULL) {
+ $info = _field_info_types();
+ $fieldable_types = $info['fieldable types'];
+ if ($obj_type) {
+ if (isset($fieldable_types[$obj_type])) {
+ return $fieldable_types[$obj_type];
+ }
+ }
+ else {
+ return $fieldable_types;
+ }
+}
+
+/**
+ * Return an array of fieldable bundle names and labels, for an individual
+ * object type or for all object types.
+ */
+function field_info_bundles($obj_type = NULL) {
+ $info = _field_info_types();
+ $bundles = array();
+ foreach ($info['fieldable types'] as $type => $fieldable_info) {
+ if (empty($obj_type) || $obj_type == $type) {
+ $bundles += $fieldable_info['bundles'];
+ }
+ }
+ return $bundles;
+}
+
+/**
+ * Identity the type of entity that created a bundle.
+ * // TODO : might not be needed depending on how we solve
+ * // the 'namespace bundle names' issue
+ */
+function field_info_bundle_entity($bundle) {
+ $info = _field_info_types();
+ foreach ($info['fieldable types'] as $type => $fieldable_info) {
+ if (isset($fieldable_info['bundles'][$bundle])) {
+ return $type;
+ }
+ }
+ return FALSE;
+}
+
+/**
+ * Return array of all field data, keyed by field name.
+ *
+ * @return
+ * An array of Field objects.
+ */
+function field_info_fields() {
+ $info = _field_info_fields();
+ return $info['fields'];
+}
+
+/**
+ * Return data about an individual field.
+ *
+ * @param $field_name
+ */
+function field_info_field($field_name) {
+ $info = _field_info_fields();
+ if (isset($info['fields'][$field_name])) {
+ return $info['fields'][$field_name];
+ }
+}
+
+
+/**
+ * Return an array of instance data for a given bundle,
+ * or for all known bundles, keyed by bundle name and field name.
+ *
+ * @param $bundle_name
+ * If set, return information on just this bundle.
+ */
+function field_info_instances($bundle_name = NULL) {
+ $info = _field_info_fields();
+ if (!isset($bundle_name)) {
+ return $info['instances'];
+ }
+ if (isset($info['instances'][$bundle_name])) {
+ return $info['instances'][$bundle_name];
+ }
+ return array();
+}
+
+/**
+ * Return an array of instance data for a specific field and bundle.
+ */
+function field_info_instance($field_name, $bundle_name) {
+ $info = _field_info_fields();
+ if (isset($info['instances'][$bundle_name][$field_name])) {
+ return $info['instances'][$bundle_name][$field_name];
+ }
+}
+
+/**
+ * Return valid formatter type and settings.
+ *
+ * Backs up to default formatter and settings if the intended formatter is no
+ * longer available. This might happen when the formatter has been renamed in
+ * the module, or if the module has been disabled since then.
+ */
+function _field_get_formatter($display, $field) {
+ if ($display['type'] != 'hidden') {
+ $formatter_type = field_info_formatter_types($display['type']);
+ if (empty($formatter_type)) {
+ $field_type = field_info_field_types($field['type']);
+ $display['type'] = $field_type['default_formatter'];
+ $formatter_type = field_info_formatter_types($display['type']);
+ }
+ $function = $formatter_type['module'] .'_field_formatter_settings';
+ if (drupal_function_exists($function)) {
+ $display['settings'] += $function($display['type']);
+ }
+ }
+ return $display;
+}
+
+/**
+ * Return a field type's default settings.
+ *
+ * @param $type
+ * A field type name.
+ * @return
+ * The field type's default settings, as provided by hook_field_info(), or an
+ * empty array.
+ */
+function field_info_field_settings($type) {
+ $info = field_info_field_types($type);
+ return isset($info['settings']) ? $info['settings'] : array();
+}
+
+/**
+ * Return a field type's default instance settings.
+ *
+ * @param $type
+ * A field type name.
+ * @return
+ * The field type's default instance settings, as provided by
+ * hook_field_info(), or an empty array.
+ */
+function field_info_instance_settings($type) {
+ $info = field_info_field_types($type);
+ return isset($info['instance_settings']) ? $info['instance_settings'] : array();
+}
+
+/**
+ * Return a field widget's default settings.
+ *
+ * @param $type
+ * A widget type name.
+ * @return
+ * The field type's default settings, as provided by hook_field_info(), or an
+ * empty array.
+ */
+function field_info_widget_settings($type) {
+ $info = field_info_widget_types($type);
+ return isset($info['settings']) ? $info['settings'] : array();
+}
+
+/**
+ * Return a field formatter's default settings.
+ *
+ * @param $type
+ * A field formatter type name.
+ * @return
+ * The field formatter's default settings, as provided by
+ * hook_field_info(), or an empty array.
+ */
+function field_info_formatter_settings($type) {
+ $info = field_info_formatter_types($type);
+ return isset($info['settings']) ? $info['settings'] : array();
+}
+
+/**
+ * Collate all information on field types, widget types and related structures.
+ *
+ * @param $reset
+ * If TRUE, clear the cache. The information will be rebuilt from the database
+ * next time it is needed. Defaults to FALSE.
+ * @return
+ * If $reset is TRUE, nothing.
+ * If $reset is FALSE, an array containing the following elements:
+ *
+ * field types: array of hook_field_info() results, keyed by field_type.
+ * * label, description, settings, instance_settings, default_widget,
+ * default_formatter, behaviors: from hook_field_info()
+ * * module: the module that exposes the field type
+ *
+ * widget types: array of hook_field_widget_info() results, keyed by
+ * widget_type.
+ * * label, field types, settings, behaviors: from hook_field_widget_info()
+ * * module: module that exposes the widget type
+ *
+ * formatter types: array of hook_field_formatter_info() results, keyed by
+ * formatter_type.
+ * * label, field types, behaviors: from hook_field_formatter_info()
+ * * module: module that exposes the formatter type
+
+ * fieldable types: array of hook_fieldable_info() results, keyed by entity_type.
+ * * name, id key, revision key, bundle key, cacheable, bundles: from
+ * hook_fieldable_info()
+ * * module: module that exposes the entity type
+ */
+function _field_info_types($reset = FALSE) {
+ static $info;
+
+ if ($reset) {
+ $info = NULL;
+ cache_clear_all('field_info_types', 'cache_field');
+ return;
+ }
+
+ if (!isset($info)) {
+ if ($cached = cache_get('field_info_types', 'cache_field')) {
+ $info = $cached->data;
+ }
+ else {
+ $info = array(
+ 'field types' => array(),
+ 'widget types' => array(),
+ 'formatter types' => array(),
+ 'fieldable types' => array(),
+ );
+
+ // TODO D7 : document max length for field types, widget types, formatter names...
+
+ // Populate field types.
+ foreach (module_implements('field_info') as $module) {
+ $field_types = (array) module_invoke($module, 'field_info');
+ foreach ($field_types as $name => $field_info) {
+ $info['field types'][$name] = $field_info;
+ $info['field types'][$name]['module'] = $module;
+ }
+ }
+
+ // Populate widget types.
+ foreach (module_implements('field_widget_info') as $module) {
+ $widget_types = (array) module_invoke($module, 'field_widget_info');
+ foreach ($widget_types as $name => $widget_info) {
+ $info['widget types'][$name] = $widget_info;
+ $info['widget types'][$name]['module'] = $module;
+ }
+ }
+
+ // Populate formatters.
+ foreach (module_implements('field_formatter_info') as $module) {
+ $formatter_types = (array) module_invoke($module, 'field_formatter_info');
+ foreach ($formatter_types as $name => $formatter_info) {
+ $info['formatter types'][$name] = $formatter_info;
+ $info['formatter types'][$name]['module'] = $module;
+ }
+ }
+
+ // Populate information about 'fieldable' entities.
+ foreach (module_implements('fieldable_info') as $module) {
+ $fieldable_types = (array) module_invoke($module, 'fieldable_info');
+ foreach ($fieldable_types as $name => $fieldable_info) {
+ // Provide defaults.
+ $fieldable_info += array(
+ 'revision key' => '',
+ 'bundle key' => '',
+ 'cacheable' => TRUE,
+ 'bundles' => array(),
+ );
+ // If no bundle key provided, then we assume a single bundle, named
+ // after the type of the object. Make sure the bundle created
+ // has the human-readable name we need for bundle messages.
+ if (empty($fieldable_info['bundle key'])) {
+ $fieldable_info['bundles'] = array($name => $fieldable_info['name']);
+ }
+ $info['fieldable types'][$name] = $fieldable_info;
+ $info['fieldable types'][$name]['module'] = $module;
+ }
+ }
+
+ cache_set('field_info_types', $info, 'cache_field');
+ }
+ }
+
+ return $info;
+}
+
+/**
+ * Collate all information on existing fields and instances.
+ *
+ * @param $reset
+ * If TRUE, clear the cache. The information will be rebuilt from the database
+ * next time it is needed. Defaults to FALSE.
+ * @return
+ * If $reset is TRUE, nothing.
+ * If $reset is FALSE, an array containing the following elements:
+ *
+ * fields: array of all defined Field objects, keyed by field name
+ *
+ * instances: array of bundled field info, keyed by bundle name
+ * * contains all FieldInstance objects for this bundle, keyed by field name.
+ */
+function _field_info_fields($reset = FALSE) {
+ static $info;
+
+ if ($reset) {
+ $info = NULL;
+ cache_clear_all('field_info_fields', 'cache_field');
+ return;
+ }
+
+ if (!isset($info)) {
+ if ($cached = cache_get('field_info_fields', 'cache_field')) {
+ $info = $cached->data;
+ }
+ else {
+ $info = array(
+ 'fields' => field_read_fields(),
+ 'instances' => array_fill_keys(array_keys(field_info_bundles()), array()),
+ );
+
+ // Populate instances.
+ $instances = field_read_instances();
+ foreach ($instances as $instance) {
+ $info['instances'][$instance['bundle']][$instance['field_name']] = $instance;
+ }
+
+ cache_set('field_info_fields', $info, 'cache_field');
+ }
+ }
+
+ return $info;
+}
+
+/**
+ * Registry of available build modes.
+ * TODO : move into hook_fieldable_info() ?
+ */
+function field_build_modes($obj_type) {
+ static $info;
+
+ if (!isset($info[$obj_type])) {
+ // module_invoke_all messes numeric keys.
+ // TODO : revisit when we move away from numeric build modes.
+ $info[$obj_type] = array();
+ foreach (module_implements('field_build_modes') as $module) {
+ $info[$obj_type] += module_invoke($module, 'field_build_modes', $obj_type);
+ }
+ }
+ return $info[$obj_type];
+}
+
+/**
+ * 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);
+ _field_info_types(TRUE);
+ _field_info_fields(TRUE);
+
+ // 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);
+ }
+}
+
+/**
+ * Manipulate a 2D array to reverse rows and columns.
+ *
+ * // TODO D7 : do we need this ? Seems specific to option_widgets
+ * The default data storage for fields is delta first, column names second.
+ * This is sometimes inconvenient for field modules, so this function can be
+ * used to present the data in an alternate format.
+ *
+ * @param $array
+ * The array to be transposed. It must be at least two-dimensional, and
+ * the subarrays must all have the same keys or behavior is undefined.
+ * @return
+ * The transposed array.
+ */
+function field_transpose_array_rows_cols($array) {
+ $result = array();
+ if (is_array($array)) {
+ foreach ($array as $key1 => $value1) {
+ if (is_array($value1)) {
+ foreach ($value1 as $key2 => $value2) {
+ if (!isset($result[$key2])) {
+ $result[$key2] = array();
+ }
+ $result[$key2][$key1] = $value2;
+ }
+ }
+ }
+ }
+ return $result;
+}
+
+/**
+ * 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...
+ * - used by Views integration in CCK D6
+ * 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)
+ * @param $formatter_name
+ * The name of the formatter to use.
+ * @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.
+ */
+function field_format($obj_type, $object, $field, $item, $formatter_name = NULL, $formatter_settings = array()) {
+ if (!is_array($field)) {
+ $field = field_info_field($field);
+ }
+
+ if (field_access('view', $field)) {
+ // Basically, we need $field, $instance, $obj_type, $object to be able to display a value...
+ list(, , $bundle) = field_attach_extract_ids($obj_type, $object);
+ $instance = field_info_instance($field['field_name'], $bundle);
+
+ $display = array(
+ 'type' => $formatter_name,
+ 'settings' => $formatter_settings,
+ );
+ $display = _field_get_formatter($display, $field);
+ if ($display['type'] && $display['type'] !== 'hidden') {
+ $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,
+ '#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);
+ }
+ }
+}
+
+/**
+ * Render a single field, fully themed with label and multiple values.
+ *
+ * To be used by third-party code (Views, Panels...) that needs to output
+ * an isolated field. Do *not* use inside node templates, use the
+ * $FIELD_NAME_rendered variables instead.
+ *
+ * By default, the field is displayed using the settings defined for the
+ * 'full' or 'teaser' contexts (depending on the value of the $teaser param).
+ * Set $node->build_mode to a different value to use a different context.
+ *
+ * Different settings can be specified by adjusting $field['display'].
+ *
+ * @param $field
+ * The field definition.
+ * @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.
+ * @param $teaser
+ * Similar to hook_nodeapi('view')
+ * @return
+ * The themed output for the field.
+ */
+function field_view_field($obj_type, $object, $field, $instance, $teaser = FALSE) {
+ $output = '';
+ if (isset($object->$field['field_name'])) {
+ $items = $object->$field['field_name'];
+
+ // Use 'full'/'teaser' if not specified otherwise.
+ $object->build_mode = isset($object->build_mode) ? $object->build_mode : NODE_BUILD_NORMAL;
+
+ // One-field equivalent to _field_invoke('sanitize').
+ $function = $field['module'] .'_field_sanitize';
+ if (drupal_function_exists($function)) {
+ $function($obj_type, $object, $field, $instance, $items);
+ $object->$field['field_name'] = $items;
+ }
+
+ $view = field_field_view($obj_type, $object, $field, $instance, $items, $teaser);
+ // TODO : what about hook_field_attach_view ?
+
+ // field_field('view') adds a wrapper to handle variables and 'excluded'
+ // fields for node templates. We bypass it and render the actual field.
+ $output = drupal_render($view[$field['field_name']]['field']);
+ }
+ 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.
+ *
+ * The $variables array contains the following arguments:
+ * - $object
+ * - $field
+ * - $items
+ * - $teaser
+ * - $page
+ *
+ * @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']);
+
+ $variables['object'] = $element['#object'];
+ $variables['field'] = $field;
+ $variables['instance'] = $instance;
+ $variables['items'] = array();
+
+ if ($element['#single']) {
+ // Single value formatter.
+ foreach (element_children($element['items']) as $delta) {
+ $variables['items'][$delta] = $element['items'][$delta]['#item'];
+ // Use isset() to avoid undefined index message on #children when field values are empty.
+ $variables['items'][$delta]['view'] = isset($element['items'][$delta]['#children']) ? $element['items'][$delta]['#children'] : '';
+ }
+ }
+ else {
+ // Multiple values formatter.
+ // We display the 'all items' output as $items[0], as if it was the
+ // output of a single valued field.
+ // Raw values are still exposed for all items.
+ foreach (element_children($element['items']) as $delta) {
+ $variables['items'][$delta] = $element['items'][$delta]['#item'];
+ }
+ $variables['items'][0]['view'] = $element['items']['#children'];
+ }
+
+ $variables['teaser'] = $element['#teaser'];
+ $variables['page'] = (bool)menu_get_object();
+
+ $field_empty = TRUE;
+
+ foreach ($variables['items'] as $delta => $item) {
+ if (!isset($item['view']) || (empty($item['view']) && (string)$item['view'] !== '0')) {
+ $variables['items'][$delta]['empty'] = TRUE;
+ }
+ else {
+ $field_empty = FALSE;
+ $variables['items'][$delta]['empty'] = FALSE;
+ }
+ }
+
+ $additions = array(
+ 'field_type' => $field['type'],
+ 'field_name' => $field['field_name'],
+ 'field_type_css' => strtr($field['type'], '_', '-'),
+ 'field_name_css' => strtr($field['field_name'], '_', '-'),
+ 'label' => check_plain(t($instance['label'])),
+ 'label_display' => $element['#label_display'],
+ 'field_empty' => $field_empty,
+ 'template_files' => array(
+ 'field',
+ 'field-'. $element['#field_name'],
+ 'field-'. $bundle,
+ 'field-'. $element['#field_name'] .'-'. $bundle,
+ ),
+ );
+ $variables = array_merge($variables, $additions);
+}
+
+// TODO D7: needed ?
+/**
+ * Helper function to identify inactive fields.
+ */
+function field_inactive_fields($type_name = NULL) {
+// module_load_include('inc', 'field', 'includes/field.crud');
+// if (!empty($type_name)) {
+// $param = array('type_name' => $type_name);
+// $inactive = array($type_name => array());
+// }
+// else {
+// $param = array();
+// $inactive = array();
+// }
+// $all = field_field_instance_read($param, TRUE);
+// $active = array_keys(field_fields());
+// foreach ($all as $field) {
+// if (!in_array($field['field_name'], $active)) {
+// $inactive[$field['type_name']][$field['field_name']] = field_field_instance_expand($field);
+// }
+// }
+// if (!empty($type_name)) {
+// return $inactive[$type_name];
+// }
+// return $inactive;
+}
=== added file 'modules/field/field.node_form.inc'
--- modules/field/field.node_form.inc 1970-01-01 00:00:00 +0000
+++ modules/field/field.node_form.inc 2009-01-15 16:50:16 +0000
@@ -0,0 +1,415 @@
+ $field,
+ 'instance' => $instance,
+ );
+ // TODO : why do we need this ?
+ $form['#cache'] = FALSE;
+
+ // If no access to edit the field, skip widget processing and just set the value.
+ $access = field_access('edit', $field);
+
+ if (!$access) {
+ $addition[$field_name] = array(
+ '#access' => $access,
+ '#type' => 'value',
+ '#value' => $items,
+ );
+ return $addition;
+ }
+
+ // Populate with default values if we're creating a new object.
+ if (empty($items) && empty($id)) {
+ switch (field_behaviors_widget('default value', $instance)) {
+ case FIELD_BEHAVIOR_CUSTOM:
+ $default_value_function = $instance['widget']['module'] .'_widget_default_value';
+ break;
+ case FIELD_BEHAVIOR_DEFAULT:
+ $default_value_function = 'field_widget_default_value';
+ break;
+ }
+ if (isset($default_value_function) && drupal_function_exists($default_value_function)) {
+ $items = $default_value_function($obj_type, $object, $field, $instance, $form, $form_state, 0);
+ }
+ }
+
+ $form_element = array();
+
+ // If field module handles multiple values for this form element,
+ // and we are displaying an individual element, process the multiple value
+ // form.
+ if (!isset($get_delta) && field_behaviors_widget('multiple values', $instance) == FIELD_BEHAVIOR_DEFAULT) {
+ $form_element = field_multiple_value_form($field, $instance, $items, $form, $form_state);
+ }
+ // If the widget is handling multiple values (e.g optionwidgets),
+ // or if we are displaying an individual element, just get a single form
+ // element and make it the $delta value.
+ else {
+ $delta = isset($get_delta) ? $get_delta : 0;
+ $function = $instance['widget']['module'] .'_field_widget';
+ if (drupal_function_exists($function)) {
+ if ($element = $function($form, $form_state, $instance, $items, $delta)) {
+ $defaults = array(
+ '#required' => $get_delta > 0 ? FALSE : $instance['required'],
+ '#columns' => array_keys($field['columns']),
+ '#title' => check_plain(t($instance['label'])),
+ '#description' => field_filter_xss($instance['description']),
+ '#delta' => $delta,
+ '#field_name' => $field['field_name'],
+ '#bundle' => $instance['bundle'],
+ );
+ $element = array_merge($element, $defaults);
+ // If we're processing a specific delta value for a field where the
+ // field module handles multiples, set the delta in the result.
+ // For fields that handle their own processing, we can't make assumptions
+ // about how the field is structured, just merge in the returned value.
+ if (field_behaviors_widget('multiple values', $instance) == FIELD_BEHAVIOR_DEFAULT) {
+ $form_element[$delta] = $element;
+ }
+ else {
+ $form_element = $element;
+ }
+ }
+ }
+ }
+
+ if ($form_element) {
+ $defaults = array(
+ '#field_name' => $field['field_name'],
+ '#tree' => TRUE,
+ '#weight' => $instance['weight'],
+ '#access' => $access,
+ );
+
+ $addition[$field['field_name']] = array_merge($form_element, $defaults);
+ $form['#fields'][$field['field_name']]['form_path'] = array($field['field_name']);
+ }
+
+ return $addition;
+}
+
+/**
+ * Special handling to create form elements for multiple values.
+ *
+ * Handles generic features for multiple fields:
+ * - number of widgets
+ * - AHAH-'add more' button
+ * - drag-n-drop value reordering
+ */
+function field_multiple_value_form($field, $instance, $items, &$form, &$form_state) {
+ $field = field_info_field($instance['field_name']);
+ $field_name = $field['field_name'];
+
+ switch ($field['cardinality']) {
+ case FIELD_CARDINALITY_UNLIMITED:
+ $filled_items = field_set_empty($field, $items);
+ $current_item_count = isset($form_state['item_count'][$field_name])
+ ? $form_state['item_count'][$field_name]
+ : count($items);
+ // We always want at least one empty icon for the user to fill in.
+ $max = ($current_item_count > count($filled_items))
+ ? $current_item_count - 1
+ : $current_item_count;
+
+ break;
+ default:
+ $max = $field['cardinality'] - 1;
+ break;
+ }
+
+ $title = check_plain(t($instance['label']));
+ $description = field_filter_xss(t($instance['description']));
+
+ $form_element = array(
+ '#theme' => 'field_multiple_value_form',
+ '#multiple' => $field['cardinality'],
+ '#title' => $title,
+ '#required' => $instance['required'],
+ '#description' => $description,
+ );
+
+ $function = $instance['widget']['module'] .'_field_widget';
+ if (drupal_function_exists($function)) {
+ for ($delta = 0; $delta <= $max; $delta++) {
+ if ($element = $function($form, $form_state, $instance, $items, $delta)) {
+ $multiple = $field['cardinality'] > 1 || $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED;
+ $defaults = array(
+ '#title' => $multiple ? '' : $title,
+ '#description' => $multiple ? '' : $description,
+ '#required' => $delta == 0 && $instance['required'],
+ '#weight' => $delta,
+ '#delta' => $delta,
+ '#columns' => array_keys($field['columns']),
+ '#field_name' => $field_name,
+ '#bundle' => $instance['bundle'],
+ );
+
+ // Add an input field for the delta (drag-n-drop reordering), which will
+ // be hidden by tabledrag js behavior.
+ if ($multiple) {
+ // We name the element '_weight' to avoid clashing with column names
+ // defined by field modules.
+ $element['_weight'] = array(
+ '#type' => 'weight',
+ '#delta' => $max, // this 'delta' is the 'weight' element's property
+ '#default_value' => isset($items[$delta]['_weight']) ? $items[$delta]['_weight'] : $delta,
+ '#weight' => 100,
+ );
+ }
+
+ $form_element[$delta] = array_merge($element, $defaults);
+ }
+ }
+
+ // Add AHAH add more button, if not working with a programmed form.
+ if ($field['cardinality'] == FIELD_CARDINALITY_UNLIMITED && empty($form['#programmed'])) {
+ // Make sure the form is cached so ahah can work.
+ $form['#cache'] = TRUE;
+ $bundle_name_url_str = str_replace('_', '-', $instance['bundle']);
+ $field_name_url_str = str_replace('_', '-', $field_name);
+
+ $form_element[$field_name .'_add_more'] = array(
+ '#type' => 'submit',
+ '#name' => $field_name .'_add_more',
+ '#value' => t('Add another item'),
+ '#weight' => $instance['weight'] + $max + 1,
+ // Submit callback for disabled JavaScript.
+ '#submit' => array('field_add_more_submit'),
+ '#ahah' => array(
+ 'path' => 'field/js_add_more/'. $bundle_name_url_str .'/'. $field_name_url_str,
+ 'wrapper' => $field_name_url_str .'-items',
+ 'method' => 'replace',
+ 'effect' => 'fade',
+ ),
+ // When JS is disabled, the field_add_more_submit handler will find
+ // the relevant field using these entries.
+ '#field_name' => $field_name,
+ '#bundle' => $instance['bundle'],
+ );
+
+ // Add wrappers for the fields and 'more' button.
+ $form_element['#prefix'] = '';
+ $form_element[$field_name .'_add_more']['#prefix'] = '
';
+ $form_element[$field_name .'_add_more']['#suffix'] = '
'. $element['#description'] .'
' : '';
+ $output .= drupal_render($element[$element['#field_name'] .'_add_more']);
+
+ drupal_add_tabledrag($table_id, 'order', 'sibling', $order_class);
+ }
+ else {
+ foreach (element_children($element) as $key) {
+ $output .= drupal_render($element[$key]);
+ }
+ }
+
+ return $output;
+}
+
+/**
+ * Submit handler to add more choices to a field form. This handler is used when
+ * JavaScript is not available. It makes changes to the form state and the
+ * entire form is rebuilt during the page reload.
+ */
+function field_add_more_submit($form, &$form_state) {
+ // Set the form to rebuild and run submit handlers.
+ node_form_submit_build_node($form, $form_state);
+ $field_name = $form_state['clicked_button']['#field_name'];
+
+ // Make the changes we want to the form state.
+ if ($form_state['values'][$field_name][$field_name .'_add_more']) {
+ $form_state['item_count'][$field_name] = count($form_state['values'][$field_name]);
+ }
+}
+
+/**
+ * Menu callback for AHAH addition of new empty widgets.
+ */
+function field_add_more_js($bundle_name, $field_name) {
+ // Arguments are coming from the url, so we translate back dashes.
+ $field_name = str_replace('-', '_', $field_name);
+
+ $invalid = FALSE;
+ if (empty($_POST['form_build_id'])) {
+ // Invalid request.
+ $invalid = TRUE;
+ }
+
+ // Retrieve the cached form.
+ $form_state = array('submitted' => FALSE);
+ $form_build_id = $_POST['form_build_id'];
+ $form = form_get_cache($form_build_id, $form_state);
+ if (!$form) {
+ // Invalid form_build_id.
+ $invalid = TRUE;
+ }
+
+ // Retrieve field information.
+ $field = $form['#fields'][$field_name]['field'];
+ $instance = $form['#fields'][$field_name]['instance'];
+ $form_path = $form['#fields'][$field_name]['form_path'];
+ // TODO D7 : abstract $_POST[$field_name] path too ?
+ if ($field['cardinality'] != FIELD_CARDINALITY_UNLIMITED) {
+ // Ivnalid
+ $invalid = TRUE;
+ }
+
+ if ($invalid) {
+ drupal_json(array('data' => ''));
+ exit;
+ }
+
+ // We don't simply return a new empty widget row to append to existing ones,
+ // because:
+ // - ahah.js won't simply let us add a new row to a table
+ // - attaching the 'draggable' behavior won't be easy
+ // So we resort to rebuilding the whole table of widgets including the
+ // existing ones, which makes us jump through a few hoops.
+
+ // The form that we get from the cache is unbuilt. We need to build it so
+ // that _value callbacks can be executed and $form_state['values'] populated.
+ // We only want to affect $form_state['values'], not the $form itself
+ // (built forms aren't supposed to enter the cache) nor the rest of
+ // $form_state, so we use copies of $form and $form_state.
+ $form_copy = $form;
+ $form_state_copy = $form_state;
+ $form_copy['#post'] = array();
+ form_builder($_POST['form_id'], $form_copy, $form_state_copy);
+ // Just grab the data we need.
+ $form_state['values'] = $form_state_copy['values'];
+ // Reset cached ids, so that they don't affect the actual form we output.
+ form_clean_id(NULL, TRUE);
+
+ // Sort the $form_state['values'] we just built *and* the incoming $_POST data
+ // according to d-n-d reordering.
+ unset($form_state['values'][$field_name][$field['field_name'] .'_add_more']);
+ foreach ($_POST[$field_name] as $delta => $item) {
+ $form_state['values'][$field_name][$delta]['_weight'] = $item['_weight'];
+ }
+ $form_state['values'][$field_name] = _field_sort_items($field, $form_state['values'][$field_name]);
+ $_POST[$field_name] = _field_sort_items($field, $_POST[$field_name]);
+
+ // Build our new form element for the whole field, asking for one more element.
+ $form_state['item_count'] = array($field_name => count($_POST[$field_name]) + 1);
+ $items = $form_state['values'][$field_name];
+ $form_element = field_field_form(NULL, NULL, $field, $instance, $items, $form, $form_state);
+ // Let other modules alter it.
+ drupal_alter('form', $form_element, array(), 'field_add_more_js');
+
+ // Add the new element at the right location in the (original, unbuilt) form.
+ $target = &$form;
+ foreach ($form_path as $key) {
+ $target = &$target[$key];
+ }
+ $target = $form_element[$field_name];
+
+ // Save the new definition of the form.
+ $form_state['values'] = array();
+ form_set_cache($form_build_id, $form, $form_state);
+
+ // Build the new form against the incoming $_POST values so that we can
+ // render the new element.
+ $delta = max(array_keys($_POST[$field_name])) + 1;
+ $_POST[$field_name][$delta]['_weight'] = $delta;
+ $form_state = array('submitted' => FALSE);
+ $form += array(
+ '#post' => $_POST,
+ '#programmed' => FALSE,
+ );
+ $form = form_builder($_POST['form_id'], $form, $form_state);
+
+ // Render the new output.
+ // We get fetch the form element from the built $form.
+ $field_form = $form;
+ foreach ($form_path as $key) {
+ $field_form = $field_form[$key];
+ }
+ // We add a div around the new field to receive the ahah effect.
+ $field_form[$delta]['#prefix'] = ''. (isset($field_form[$delta]['#prefix']) ? $field_form[$delta]['#prefix'] : '');
+ $field_form[$delta]['#suffix'] = (isset($field_form[$delta]['#suffix']) ? $field_form[$delta]['#suffix'] : '') .'
';
+
+ // If a newly inserted widget contains AHAH behaviors, they normally won't
+ // work because AHAH doesn't know about those - it just attaches to the exact
+ // form elements that were initially specified in the Drupal.settings object.
+ // The new ones didn't exist then, so we need to update Drupal.settings
+ // by ourselves in order to let AHAH know about those new form elements.
+ $javascript = drupal_add_js(NULL, NULL);
+ $output_js = isset($javascript['setting']) ? '' : '';
+
+ $output = theme('status_messages') . drupal_render($field_form) . $output_js;
+ drupal_json(array('status' => TRUE, 'data' => $output));
+ exit;
+}
=== added file 'modules/field/field.test'
--- modules/field/field.test 1970-01-01 00:00:00 +0000
+++ modules/field/field.test 2009-01-15 16:50:16 +0000
@@ -0,0 +1,979 @@
+ t('Field Attach tests'),
+ 'description' => t("Test Field Attach API functions."),
+ 'group' => t('Field')
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field_sql_storage', 'field', 'field_test');
+
+ $this->field_name = strtolower($this->randomName().'_field_name');
+ $this->table = _field_sql_storage_tablename($this->field_name);
+ $this->revision_table = _field_sql_storage_revision_tablename($this->field_name);
+ $this->field = array('field_name' => $this->field_name, 'type' => 'test_field', 'cardinality' => 4);
+ field_create_field($this->field);
+ $this->instance = array(
+ 'field_name' => $this->field_name,
+ 'bundle' => 'test_bundle',
+ 'label' => $this->randomName().'_label',
+ 'description' => $this->randomName().'_description',
+ 'weight' => mt_rand(0, 127),
+ 'settings' => array(
+ 'test_instance_setting' => $this->randomName(),
+ ),
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'label' => 'Test Field',
+ 'settings' => array(
+ 'test_widget_setting' => $this->randomName(),
+ )
+ )
+ );
+ field_create_instance($this->instance);
+ }
+
+ function testFieldAttachLoad() {
+ $entity_type = 'field_test_entity';
+ $eid = 0;
+
+ $columns = array('entity', 'entity_id', 'revision_id', 'delta', $this->field_name .'_value');
+
+ // Insert data for four revisions to the field revisions table
+ $query = db_insert($this->revision_table)->fields($columns);
+ for ($evid = 0; $evid < 4; ++$evid) {
+ $values[$evid] = array();
+ // Note: we insert one extra value ('<=' instead of '<').
+ for ($delta = 0; $delta <= $this->field['cardinality']; $delta++) {
+ $value = mt_rand(0, 127);
+ $values[$evid][] = $value;
+ $query->values(array($entity_type, $eid, $evid, $delta, $value));
+ }
+ }
+ $query->execute();
+
+ // Insert data for the "most current revision" into the field table
+ $query = db_insert($this->table)->fields($columns);
+ foreach ($values[0] as $delta => $value) {
+ $query->values(array($entity_type, $eid, 0, $delta, $value));
+ }
+ $query->execute();
+
+ // Load the "most current revision"
+ $entity = field_test_entity_get_entity($eid, 0, $this->instance['bundle']);
+ field_attach_load($entity_type, array($eid => $entity));
+ foreach ($values[0] as $delta => $value) {
+ if ($delta < $this->field['cardinality']) {
+ $this->assertEqual($entity->{$this->field_name}[$delta]['value'], $value, "Value $delta is loaded correctly for current revision");
+ }
+ else {
+ $this->assertFalse(array_key_exists($delta, $entity->{$this->field_name}), "No extraneous value gets loaded for current revision.");
+ }
+ }
+
+ // Load every revision
+ for ($evid = 0; $evid < 4; ++$evid) {
+ $entity = field_test_entity_get_entity($eid, $evid, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array($eid => $entity));
+ foreach ($values[$evid] as $delta => $value) {
+ if ($delta < $this->field['cardinality']) {
+ $this->assertEqual($entity->{$this->field_name}[$delta]['value'], $value, "Value $delta for revision $evid is loaded correctly");
+ }
+ else {
+ $this->assertFalse(array_key_exists($delta, $entity->{$this->field_name}), "No extraneous value gets loaded for revision $evid.");
+ }
+ }
+ }
+ }
+
+ function testFieldAttachLoadMultiple() {
+ // TODO : test the 'multiple' aspect of load:
+ // define 2 bundles, 3 fields
+ // bundle1 gets instances of field1, field2
+ // bundle2 gets instances of field1, field3
+ // load 2 entities (one for each bundle) in a single load
+ // check that everything gets loaded ok.
+ }
+
+ function testFieldAttachInsertAndUpdate() {
+ $entity_type = 'field_test_entity';
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+
+ // Test insert.
+ $values = array();
+ // Note: we try to insert one extra value ('<=' instead of '<').
+ // TODO : test empty values filtering and "compression" (store consecutive deltas).
+ for ($delta = 0; $delta <= $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(0, 127);
+ }
+ $entity->{$this->field_name} = $rev_values[0] = $values;
+ field_attach_insert($entity_type, $entity);
+
+ $rows = db_select($this->table, 't')->fields('t')->execute()->fetchAllAssoc('delta', PDO::FETCH_ASSOC);
+ foreach ($values as $delta => $value) {
+ if ($delta < $this->field['cardinality']) {
+ $this->assertEqual($rows[$delta][$this->field_name . '_value'], $value['value'], t("Value $delta is inserted correctly"));
+ }
+ else {
+ $this->assertFalse(array_key_exists($delta, $rows), "No extraneous value gets inserted.");
+ }
+ }
+
+ // Test update.
+ $entity = field_test_entity_get_entity(0, 1, $this->instance['bundle']);
+ $values = array();
+ // Note: we try to update one extra value ('<=' instead of '<').
+ for ($delta = 0; $delta <= $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(0, 127);
+ }
+ $entity->{$this->field_name} = $rev_values[1] = $values;
+ field_attach_update($entity_type, $entity);
+ $rows = db_select($this->table, 't')->fields('t')->execute()->fetchAllAssoc('delta', PDO::FETCH_ASSOC);
+ foreach ($values as $delta => $value) {
+ if ($delta < $this->field['cardinality']) {
+ $this->assertEqual($rows[$delta][$this->field_name . '_value'], $value['value'], t("Value $delta is updated correctly"));
+ }
+ else {
+ $this->assertFalse(array_key_exists($delta, $rows), "No extraneous value gets updated.");
+ }
+ }
+
+ // Check that data for both revisions are in the revision table.
+ // We make sure each value is stored correctly, then unset it.
+ // When an entire revision's values are unset (remembering that we
+ // put one extra value in $values per revision), unset the entire
+ // revision. Then, if $rev_values is empty at the end, all
+ // revision data was found.
+ $results = db_select($this->revision_table, 't')->fields('t')->execute();
+ foreach ($results as $row) {
+ $this->assertEqual($row->{$this->field_name . '_value'}, $rev_values[$row->revision_id][$row->delta]['value'], "Value {$row->delta} for revision {$row->revision_id} stored correctly");
+ unset($rev_values[$row->revision_id][$row->delta]);
+ if (count($rev_values[$row->revision_id]) == 1) {
+ unset($rev_values[$row->revision_id]);
+ }
+ }
+ $this->assertTrue(empty($rev_values), "All values for all revisions are stored in revision table {$this->revision_table}");
+
+ // Check that update leaves the field data untouched if $object has no
+ // $field_name key.
+ unset($entity->{$this->field_name});
+ field_attach_update($entity_type, $entity);
+ $rows = db_select($this->table, 't')->fields('t')->execute()->fetchAllAssoc('delta', PDO::FETCH_ASSOC);
+ foreach ($values as $delta => $value) {
+ if ($delta < $this->field['cardinality']) {
+ $this->assertEqual($rows[$delta][$this->field_name . '_value'], $value['value'], t("Update with no field_name entry leaves value $delta untouched"));
+ }
+ }
+
+ // Check that update with an empty $object->$field_name empties the field.
+ $entity->{$this->field_name} = NULL;
+ field_attach_update($entity_type, $entity);
+ $rows = db_select($this->table, 't')->fields('t')->execute()->fetchAllAssoc('delta', PDO::FETCH_ASSOC);
+ $this->assertEqual(count($rows), 0, t("Update with an empty field_name entry empties the field."));
+ }
+
+ // Test insert and update with missing or invalid fields. For the
+ // most part, these tests pass by not crashing or causing exceptions.
+ function testFieldAttachSaveMissingData() {
+ $entity_type = 'field_test_entity';
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+
+ // Insert: Field is missing
+ field_attach_insert($entity_type, $entity);
+ $count = db_result(db_query("SELECT COUNT(*) FROM {{$this->table}}"));
+ $this->assertEqual($count, 0, 'Missing field results in no inserts');
+
+ // Insert: Field is NULL
+ $entity->{$this->field_name} = NULL;
+ field_attach_insert($entity_type, $entity);
+ $count = db_result(db_query("SELECT COUNT(*) FROM {{$this->table}}"));
+ $this->assertEqual($count, 0, 'NULL field results in no inserts');
+
+ // Add some real data
+ $entity->{$this->field_name} = array(0 => array('value' => 1));
+ field_attach_insert($entity_type, $entity);
+ $count = db_result(db_query("SELECT COUNT(*) FROM {{$this->table}}"));
+ $this->assertEqual($count, 1, 'Field data saved');
+
+ // Update: Field is missing. Data should survive.
+ unset($entity->{$this->field_name});
+ field_attach_update($entity_type, $entity);
+ $count = db_result(db_query("SELECT COUNT(*) FROM {{$this->table}}"));
+ $this->assertEqual($count, 1, 'Missing field leaves data in table');
+
+ // Update: Field is NULL Data should be wiped.
+ $entity->{$this->field_name} = NULL;
+ field_attach_update($entity_type, $entity);
+ $count = db_result(db_query("SELECT COUNT(*) FROM {{$this->table}}"));
+ $this->assertEqual($count, 0, 'NULL field leaves no data in table');
+ }
+
+ function testFieldAttachViewAndPreprocess() {
+ $entity_type = 'field_test_entity';
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+
+ // Populate values to be displayed.
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(0, 127);
+ }
+ $entity->{$this->field_name} = $values;
+
+ // Simple formatter, label displayed.
+ $formatter_setting = $this->randomName();
+ $this->instance['display'] = array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'field_test_default',
+ 'settings' => array(
+ 'test_formatter_setting' => $formatter_setting,
+ )
+ ),
+ );
+ field_update_instance($this->instance);
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $variables = field_attach_preprocess($entity_type, $entity);
+ $variable = $this->instance['field_name'] . '_rendered';
+ $this->assertTrue(isset($variables[$variable]), "Variable $variable is available in templates.");
+ $this->content = $output;
+ $this->assertRaw($this->instance['label'], "Label is displayed.");
+ $this->content = $variables[$variable];
+ $this->assertRaw($this->instance['label'], "Label is displayed (template variable).");
+ foreach ($values as $delta => $value) {
+ $this->content = $output;
+ $this->assertRaw("$formatter_setting|{$value['value']}", "Value $delta is displayed, formatter settings are applied.");
+ $this->content = $variables[$variable];
+ $this->assertRaw("$formatter_setting|{$value['value']}", "Value $delta is displayed, formatter settings are applied (template variable).");
+ }
+
+ // Label hidden.
+ $this->instance['display']['full']['label'] = 'hidden';
+ field_update_instance($this->instance);
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $variables = field_attach_preprocess($entity_type, $entity);
+ $this->content = $output;
+ $this->assertNoRaw($this->instance['label'], "Hidden label: label is not displayed.");
+ $this->content = $variables[$variable];
+ $this->assertNoRaw($this->instance['label'], "Hidden label: label is not displayed (template variable).");
+
+ // Field hidden.
+ $this->instance['display'] = array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'hidden',
+
+ ),
+ );
+ field_update_instance($this->instance);
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $variables = field_attach_preprocess($entity_type, $entity);
+ $this->assertTrue(isset($variables[$variable]), "Hidden field: variable $variable is available in templates.");
+ $this->content = $output;
+ $this->assertNoRaw($this->instance['label'], "Hidden field: label is not displayed.");
+ foreach ($values as $delta => $value) {
+ $this->assertNoRaw($value['value'], "Hidden field: value $delta is not displayed.");
+ }
+
+ // Multiple formatter.
+ $formatter_setting = $this->randomName();
+ $this->instance['display'] = array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'field_test_multiple',
+ 'settings' => array(
+ 'test_formatter_setting_multiple' => $formatter_setting,
+ )
+ ),
+ );
+ field_update_instance($this->instance);
+ $entity->content = field_attach_view($entity_type, $entity);
+ $output = drupal_render($entity->content);
+ $variables = field_attach_preprocess($entity_type, $entity);
+ $display = $formatter_setting;
+ foreach ($values as $delta => $value) {
+ $display .= "|$delta:{$value['value']}";
+ }
+ $this->content = $output;
+ $this->assertRaw($display, "Multiple formatter: all values are displayed, formatter settings are applied.");
+ $this->content = $variables[$variable];
+ $this->assertRaw($display, "Multiple formatter: all values are displayed, formatter settings are applied (template variable).");
+
+ // TODO:
+ // - check that the 'exclude' option works (if we keep it in core)
+ // - check display order with several fields
+ }
+
+ function testFieldAttachDelete() {
+ $entity_type = 'field_test_entity';
+ $rev[0] = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+
+ // Create revision 0
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(0, 127);
+ }
+ $rev[0]->{$this->field_name} = $values;
+ field_attach_insert($entity_type, $rev[0]);
+
+ // Create revision 1
+ $rev[1] = field_test_entity_get_entity(0, 1, $this->instance['bundle']);
+ $rev[1]->{$this->field_name} = $values;
+ field_attach_update($entity_type, $rev[1]);
+
+ // Create revision 2
+ $rev[2] = field_test_entity_get_entity(0, 2, $this->instance['bundle']);
+ $rev[2]->{$this->field_name} = $values;
+ field_attach_update($entity_type, $rev[2]);
+
+ // Confirm each revision loads
+ foreach (array_keys($rev) as $vid) {
+ $read = field_test_entity_get_entity(0, $vid, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array(0 => $read));
+ $this->assertEqual(count($read->{$this->field_name}), $this->field['cardinality'], "The test object revision $vid has {$this->field['cardinality']} values.");
+ }
+
+ // Delete revision 1, confirm the other two still load.
+ field_attach_delete_revision($entity_type, $rev[1]);
+ foreach (array(0, 2) as $vid) {
+ $read = field_test_entity_get_entity(0, $vid, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array(0 => $read));
+ $this->assertEqual(count($read->{$this->field_name}), $this->field['cardinality'], "The test object revision $vid has {$this->field['cardinality']} values.");
+ }
+
+ // Confirm the current revision still loads
+ $read = field_test_entity_get_entity(0, 2, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $read));
+ $this->assertEqual(count($read->{$this->field_name}), $this->field['cardinality'], "The test object current revision has {$this->field['cardinality']} values.");
+
+ // Delete all field data, confirm nothing loads
+ field_attach_delete($entity_type, $rev[2]);
+ foreach (array(0, 1, 2) as $vid) {
+ $read = field_test_entity_get_entity(0, $vid, $this->instance['bundle']);
+ field_attach_load_revision($entity_type, array(0 => $read));
+ $this->assertFalse(isset($read->{$this->field_name}), "The test object revision $vid is deleted.");
+ }
+ $read = field_test_entity_get_entity(0, 2, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $read));
+ $this->assertFalse(isset($read->{$this->field_name}), "The test object current revision is deleted.");
+ }
+
+ function testFieldAttachCreateRenameBundle() {
+ // Create a new bundle. This has to be initiated by the module so that its
+ // hook_fieldable_info() is consistent.
+ $new_bundle = 'test_bundle_' . strtolower($this->randomName());
+ field_test_create_bundle($new_bundle, $this->randomName());
+
+ // Add an instance to that bundle.
+ $this->instance['bundle'] = $new_bundle;
+ field_create_instance($this->instance);
+
+ // Save an object with data in the field.
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(0, 127);
+ }
+ $entity->{$this->field_name} = $values;
+ $entity_type = 'field_test_entity';
+ field_attach_insert($entity_type, $entity);
+
+ // Verify the field data is present on load.
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $entity));
+ $this->assertEqual(count($entity->{$this->field_name}), $this->field['cardinality'], "Data are retrieved for the new bundle");
+
+ // Rename the bundle. This has to be initiated by the module so that its
+ // hook_fieldable_info() is consistent.
+ $new_bundle = 'test_bundle_' . strtolower($this->randomName());
+ field_test_rename_bundle($this->instance['bundle'], $new_bundle);
+
+ // Check that the instance definition has been updated.
+ $this->instance = field_info_instance($this->field_name, $new_bundle);
+ $this->assertIdentical($this->instance['bundle'], $new_bundle, "Bundle name has been updated in the instance.");
+
+ // Verify the field data is present on load.
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $entity));
+ $this->assertEqual(count($entity->{$this->field_name}), $this->field['cardinality'], "Bundle name has been updated in the field storage");
+ }
+
+ function testFieldAttachDeleteBundle() {
+ // Create a new bundle. This has to be initiated by the module so that its
+ // hook_fieldable_info() is consistent.
+ $new_bundle = 'test_bundle_' . strtolower($this->randomName());
+ field_test_create_bundle($new_bundle, $this->randomName());
+
+ // Add an instance to that bundle.
+ $this->instance['bundle'] = $new_bundle;
+ field_create_instance($this->instance);
+
+ // Create a second field for the test bundle
+ $field_name = strtolower($this->randomName().'_field_name');
+ $table = _field_sql_storage_tablename($field_name);
+ $revision_table = _field_sql_storage_revision_tablename($field_name);
+ $field = array('field_name' => $field_name, 'type' => 'test_field', 'cardinality' => 1);
+ field_create_field($field);
+ $instance = array(
+ 'field_name' => $field_name,
+ 'bundle' => $this->instance['bundle'],
+ 'label' => $this->randomName().'_label',
+ 'description' => $this->randomName().'_description',
+ 'weight' => mt_rand(0, 127),
+ // test_field has no instance settings
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'settings' => array(
+ 'size' => mt_rand(0, 255))));
+ field_create_instance($instance);
+
+ // Save an object with data for both fields
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(0, 127);
+ }
+ $entity->{$this->field_name} = $values;
+ $entity->{$field_name} = array(0 => array('value' => 99));
+ $entity_type = 'field_test_entity';
+ field_attach_insert($entity_type, $entity);
+
+ // Verify the fields are present on load
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $entity));
+ $this->assertEqual(count($entity->{$this->field_name}), 4, "First field got loaded");
+ $this->assertEqual(count($entity->{$field_name}), 1, "Second field got loaded");
+
+ // Delete the bundle. This has to be initiated by the module so that its
+ // hook_fieldable_info() is consistent.
+ field_test_delete_bundle($this->instance['bundle']);
+
+ // Verify no data gets loaded
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+ field_attach_load($entity_type, array(0 => $entity));
+ $this->assertFalse(isset($entity->{$this->field_name}), "No data for first field");
+ $this->assertFalse(isset($entity->{$field_name}), "No data for second field");
+
+ // Verify that the instances are gone
+ $this->assertFalse(field_read_instance($this->field_name, $this->instance['bundle']), "First field is deleted");
+ $this->assertFalse(field_read_instance($field_name, $instance['bundle']), "Second field is deleted");
+ }
+
+ function testFieldAttachCache() {
+ // Create a revision
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(0, 127);
+ }
+ $entity->{$this->field_name} = $values;
+
+ $noncached_type = 'field_test_entity';
+ $cached_type = 'field_test_cacheable_entity';
+
+ // Non-cached type:
+ $cid = "field:$noncached_type:0:0";
+
+ // Confirm no initial cache entry
+ $this->assertFalse(cache_get($cid, 'cache_field'), 'Non-cached: no initial cache entry');
+
+ // Save, and confirm no cache entry
+ field_attach_insert($noncached_type, $entity);
+ $this->assertFalse(cache_get($cid, 'cache_field'), 'Non-cached: no cache entry on save');
+
+ // Load, and confirm no cache entry
+ field_attach_load($noncached_type, array(0 => $entity));
+ $this->assertFalse(cache_get($cid, 'cache_field'), 'Non-cached: no cache entry on load');
+
+ // Cached type:
+ $cid = "field:$cached_type:0:0";
+
+ // Confirm no initial cache entry
+ $this->assertFalse(cache_get($cid, 'cache_field'), 'Cached: no initial cache entry');
+
+ // Save, and confirm no cache entry
+ field_attach_insert($cached_type, $entity);
+ $this->assertFalse(cache_get($cid, 'cache_field'), 'Cached: no cache entry on save');
+
+ // Load, and confirm cache entry
+ field_attach_load($cached_type, array(0 => $entity));
+ $cache = cache_get($cid, 'cache_field');
+ $this->assertEqual($cache->data[$this->field_name], $values, 'Cached: correct cache entry on load');
+
+ // Delete, and confirm no cache entry
+ field_attach_delete($cached_type, $entity);
+ $this->assertFalse(cache_get($cid, 'cache_field'), 'Cached: no cache entry on save');
+ }
+
+ // Verify that field_attach_validate() invokes the correct
+ // hook_field_validate. NOTE: This tests the FAPI-connected
+ // behavior of hook_field_validate. As discussed at
+ // http://groups.drupal.org/node/18019, field validation will
+ // eventually be disconnected from FAPI, at which point this
+ // function will have to be rewritten.
+ function testFieldAttachValidate() {
+ $entity_type = 'field_test_entity';
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+
+ // Set up values to generate errors
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(1, 127);
+ $values[$delta]['_error_element'] = 'field_error_'.$delta;
+ }
+ // Arrange for item 1 not to generate an error
+ $values[1]['value'] = 1;
+ $entity->{$this->field_name} = $values;
+
+ field_attach_validate($entity_type, $entity, array());
+
+ $errors = form_get_errors();
+ foreach ($values as $delta => $value) {
+ if ($value['value'] != 1) {
+ $this->assertTrue(isset($errors[$value['_error_element']]), "Error is set on {$value['_error_element']}: {$errors[$value['_error_element']]}");
+ unset($errors[$value['_error_element']]);
+ }
+ else {
+ $this->assertFalse(isset($errors[$value['_error_element']]), "Error is not set on {$value['_error_element']}");
+ }
+ }
+ $this->assertEqual(count($errors), 0, 'No extraneous form errors set');
+ }
+
+ // Validate that FAPI elements are generated. This could be much
+ // more thorough, but it does verify that the correct widgets show up.
+ function testFieldAttachForm() {
+ $entity_type = 'field_test_entity';
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+
+ $form = $form_state = array();
+ field_attach_form($entity_type, $entity, $form, $form_state);
+
+ $this->assertEqual($form[$this->field_name]['#title'], $this->instance['label'], "Form title is {$this->instance['label']}");
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ // field_test_widget uses 'textfield'
+ $this->assertEqual($form[$this->field_name][$delta]['#type'], 'textfield', "Form delta $delta widget is textfield");
+ }
+ }
+
+ function testFieldAttachPresave() {
+ $entity_type = 'field_test_entity';
+ $entity = field_test_entity_get_entity(0, 0, $this->instance['bundle']);
+
+ $values = array();
+ for ($delta = 0; $delta < $this->field['cardinality']; $delta++) {
+ $values[$delta]['value'] = mt_rand(1, 127);
+ }
+ // field_test fields are empty if empty()
+ $values[1]['value'] = 0;
+ $entity->{$this->field_name} = $values;
+
+ field_attach_presave($entity_type, $entity);
+
+ unset($values[1]);
+ $values = array_merge($values);
+ $this->assertIdentical($entity->{$this->field_name}, $values, 'Presave filters empty values');
+ }
+}
+
+class FieldInfoTestCase extends DrupalWebTestCase {
+
+ function getInfo() {
+ return array(
+ 'name' => t('Field info tests'),
+ 'description' => t("Get information about existing fields, instances and bundles."),
+ 'group' => t('Field')
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field_sql_storage', 'field', 'field_test');
+ }
+
+ function testFieldInfo() {
+ // Test that field_test module's fields, widgets, and formatters show up.
+ $field_test_info = field_test_field_info();
+ $formatter_info = field_test_field_formatter_info();
+ $widget_info = field_test_field_widget_info();
+
+ $info = field_info_field_types();
+ foreach ($field_test_info as $t_key => $field_type) {
+ foreach ($field_type as $key => $val) {
+ $this->assertEqual($info[$t_key][$key], $val, t("Field type $t_key key $key is $val"));
+ }
+ $this->assertEqual($info[$t_key]['module'], 'field_test', t("Field type field_test module appears"));
+ }
+
+ $info = field_info_formatter_types();
+ foreach ($formatter_info as $f_key => $formatter) {
+ foreach ($formatter as $key => $val) {
+ $this->assertEqual($info[$f_key][$key], $val, t("Formatter type $f_key key $key is $val"));
+ }
+ $this->assertEqual($info[$f_key]['module'], 'field_test', t("Formatter type field_test module appears"));
+ }
+
+ $info = field_info_widget_types();
+ foreach ($widget_info as $w_key => $widget) {
+ foreach ($widget as $key => $val) {
+ $this->assertEqual($info[$w_key][$key], $val, t("Widget type $w_key key $key is $val"));
+ }
+ $this->assertEqual($info[$w_key]['module'], 'field_test', t("Widget type field_test module appears"));
+ }
+
+ // Verify that no fields or instances exist
+ $fields = field_info_fields();
+ $instances = field_info_instances(FIELD_TEST_BUNDLE);
+ $this->assertTrue(empty($fields), t('With no fields, info fields is empty.'));
+ $this->assertTrue(empty($instances), t('With no instances, info bundles is empty.'));
+
+ // Create a field, verify it shows up.
+ $field = array(
+ 'field_name' => strtolower($this->randomName()),
+ 'type' => 'test_field',
+ );
+ field_create_field($field);
+ $fields = field_info_fields();
+ $this->assertEqual(count($fields), 1, t('One field exists'));
+ $this->assertEqual($fields[$field['field_name']]['field_name'], $field['field_name'], t('info fields contains field name'));
+ $this->assertEqual($fields[$field['field_name']]['type'], $field['type'], t('info fields contains field type'));
+ $this->assertEqual($fields[$field['field_name']]['module'], 'field_test', t('info fields contains field module'));
+ $settings = array('test_field_setting' => 'dummy test string');
+ foreach ($settings as $key => $val) {
+ $this->assertEqual($fields[$field['field_name']]['settings'][$key], $val, t("Field setting $key has correct default value $val"));
+ }
+ $this->assertEqual($fields[$field['field_name']]['cardinality'], 1, t('info fields contains cardinality 1'));
+ $this->assertEqual($fields[$field['field_name']]['active'], 1, t('info fields contains active 1'));
+
+ // Create an instance, verify that it shows up
+ $instance = array(
+ 'field_name' => $field['field_name'],
+ 'bundle' => FIELD_TEST_BUNDLE,
+ 'label' => $this->randomName(),
+ 'description' => $this->randomName(),
+ 'weight' => mt_rand(0, 127),
+ // test_field has no instance settings
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ 'settings' => array(
+ 'test_setting' => 999)));
+ field_create_instance($instance);
+
+ $instances = field_info_instances($instance['bundle']);
+ $this->assertEqual(count($instances), 1, t('One instance shows up in info when attached to a bundle.'));
+ $this->assertTrue($instance < $instances[$instance['field_name']], t('Instance appears in info correctly'));
+ }
+
+ // Test that the field_info settings convenience functions work
+ function testSettingsInfo() {
+ $info = field_test_field_info();
+ foreach ($info as $type => $data) {
+ $this->assertIdentical(field_info_field_settings($type), $data['settings'], "field_info_field_settings returns {$type}'s field settings");
+ $this->assertIdentical(field_info_instance_settings($type), $data['instance_settings'], "field_info_field_settings returns {$type}'s field instance settings");
+ }
+
+ $info = field_test_field_widget_info();
+ foreach ($info as $type => $data) {
+ $this->assertIdentical(field_info_widget_settings($type), $data['settings'], "field_info_widget_settings returns {$type}'s widget settings");
+ }
+
+ $info = field_test_field_formatter_info();
+ foreach ($info as $type => $data) {
+ $this->assertIdentical(field_info_formatter_settings($type), $data['settings'], "field_info_formatter_settings returns {$type}'s formatter settings");
+ }
+ }
+}
+
+class FieldTestCase extends DrupalWebTestCase {
+ function getInfo() {
+ return array(
+ 'name' => t('Field tests'),
+ 'description' => t("Create / read /update a field."),
+ 'group' => t('Field')
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field_sql_storage', 'field', 'field_test');
+ }
+
+ // TODO : test creation with
+ // - a full fledged $field structure, check that all the values are there
+ // - a minimal $field structure, check all default values are set
+ // defer actual $field comparison to a helper function, used for the two cases above
+ /**
+ * Test the creation of a field.
+ */
+ function testCreateField() {
+ $field_definition = array(
+ 'field_name' => strtolower($this->randomName()),
+ 'type' => 'test_field',
+ );
+ field_create_field($field_definition);
+
+ $field = field_read_field($field_definition['field_name']);
+
+ // Ensure that basic properties are preserved.
+ $this->assertEqual($field['field_name'], $field_definition['field_name'], t('The field name is properly saved.'));
+ $this->assertEqual($field['type'], $field_definition['type'], t('The field type is properly saved.'));
+
+ // Ensure that cardinality defaults to 1.
+ $this->assertEqual($field['cardinality'], 1, t('Cardinality defaults to 1.'));
+
+ // Ensure that default settings are present.
+ $info = field_info_field_types($field['type']);
+ $settings = $info['settings'];
+ $this->assertIdentical($settings, $field['settings'] , t('Default field settings have been written.'));
+
+ // Check that a table has been created for the field.
+ $this->assertTrue(db_table_exists('field_data_' . $field_definition['field_name']), t('A table has been created for the field.'));
+
+ // Guarantee that the name is unique.
+ try {
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create two fields with the same name.'));
+ } catch (FieldException $e) {
+ $this->pass(t('Cannot create two fields with the same name.'));
+ }
+
+ // Check that invalid field names are rejected.
+ $field_definition['field_name'] += '_#';
+ try {
+ field_create_field($field_definition);
+ $this->fail(t('Cannot create a field with an invalid name.'));
+ } catch (FieldException $e) {
+ $this->pass(t('Cannot create a field with an invalid name.'));
+ }
+
+ // TODO : other failures
+ }
+
+ function testReadField() {
+
+ }
+
+ /**
+ * Test the deletion of a field.
+ */
+ function testDeleteField() {
+ // TODO: Also test deletion of the data stored in the field ?
+
+ // Create two fields (so we can test that only one is deleted).
+ $this->field = $this->drupalCreateField('test_field', 'test_field_name');
+ $this->another_field = $this->drupalCreateField('test_field', 'another_test_field_name');
+
+ // Create instances for each.
+ $this->instance_definition = array(
+ 'field_name' => $this->field['field_name'],
+ 'bundle' => FIELD_TEST_BUNDLE,
+ 'widget' => array(
+ 'type' => 'test_field_widget',
+ ),
+ );
+ field_create_instance($this->instance_definition);
+ $this->another_instance_definition = $this->instance_definition;
+ $this->another_instance_definition['field_name'] = $this->another_field['field_name'];
+ field_create_instance($this->another_instance_definition);
+
+ // Test that the first field is not deleted, and then delete it.
+ $field = field_read_field($this->field['field_name'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($field) && empty($field['deleted']), t('A new field is not marked for deletion.'));
+ field_delete_field($this->field['field_name']);
+
+ // Make sure that the field is marked as deleted when it is specifically
+ // loaded.
+ $field = field_read_field($this->field['field_name'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($field['deleted']), t('A deleted field is marked for deletion.'));
+
+ // Make sure that this field's instance is marked as deleted when it is
+ // specifically loaded.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($instance['deleted']), t('An instance for a deleted field is marked for deletion.'));
+
+ // Try to load the field normally and make sure it does not show up.
+ $field = field_read_field($this->field['field_name']);
+ $this->assertTrue(empty($field), t('A deleted field is not loaded by default.'));
+
+ // Try to load the instance normally and make sure it does not show up.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue(empty($instance), t('An instance for a deleted field is not loaded by default.'));
+
+ // Make sure the other field (and its field instance) are not deleted.
+ $another_field = field_read_field($this->another_field['field_name']);
+ $this->assertTrue(!empty($another_field) && empty($another_field['deleted']), t('A non-deleted field is not marked for deletion.'));
+ $another_instance = field_read_instance($this->another_instance_definition['field_name'], $this->another_instance_definition['bundle']);
+ $this->assertTrue(!empty($another_instance) && empty($another_instance['deleted']), t('An instance of a non-deleted field is not marked for deletion.'));
+ }
+}
+
+class FieldInstanceTestCase extends DrupalWebTestCase {
+ protected $field;
+
+ function getInfo() {
+ return array(
+ 'name' => t('Field instance tests'),
+ 'description' => t("Create field entities by attaching fields to entities."),
+ 'group' => t('Field')
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field_sql_storage', 'field', 'field_test');
+
+ $this->field = $this->drupalCreateField('test_field');
+ $this->instance_definition = array(
+ 'field_name' => $this->field['field_name'],
+ 'bundle' => FIELD_TEST_BUNDLE,
+ );
+ }
+
+ // TODO : test creation with
+ // - a full fledged $instance structure, check that all the values are there
+ // - a minimal $instance structure, check all default values are set
+ // defer actual $instance comparison to a helper function, used for the two cases above,
+ // and for testUpdateFieldInstance
+ function testCreateFieldInstance() {
+ field_create_instance($this->instance_definition);
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $field_type = field_info_field_types($this->field['type']);
+
+ // Check that default values are set.
+ $this->assertIdentical($instance['required'], FALSE, t('Required defaults to false.'));
+ $this->assertIdentical($instance['label'], $this->instance_definition['field_name'], t('Label defaults to field name.'));
+ $this->assertIdentical($instance['description'], '', t('Description defaults to empty string.'));
+
+ // Check that default instance settings are set.
+ $settings = array('test_instance_setting' => 'dummy test string');
+ $this->assertIdentical($settings, $instance['settings'] , t('Default instance settings have been written.'));
+ // Check that the widget is the default one.
+ $this->assertIdentical($instance['widget']['type'], $field_type['default_widget'], t('Default widget has been written.'));
+ // Check that default widget settings are set.
+ $settings = array('test_widget_setting' => 'dummy test string');
+ $this->assertIdentical($settings, $instance['widget']['settings'] , t('Default widget settings have been written.'));
+ // Check that we have display info for 'full' build_mode.
+ $this->assertTrue(isset($instance['display']['full']), t('Display for "full" build_mode has been written.'));
+ // Check that the formatter is the default one.
+ $this->assertIdentical($instance['display']['full']['type'], $field_type['default_formatter'], t('Default formatter for "full" build_mode has been written.'));
+ // Check that the default formatter settings are set.
+ $info = field_info_formatter_types($instance['display']['full']['type']);
+ $settings = $info['settings'];
+ $this->assertIdentical($settings, $instance['display']['full']['settings'] , t('Default formatter settings for "full" build_mode have been written.'));
+
+ // Guarantee that the field/bundle combination is unique.
+ try {
+ field_create_instance($this->instance_definition);
+ $this->fail(t('Cannot create two instances with the same field / bundle combination.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create two instances with the same field / bundle combination.'));
+ }
+
+ // Check that the specified field exists.
+ try {
+ $this->instance_definition['field_name'] = $this->randomName();
+ field_create_instance($this->instance_definition);
+ $this->fail(t('Cannot create an instance of a non-existing field.'));
+ }
+ catch (FieldException $e) {
+ $this->pass(t('Cannot create an instance of a non-existing field.'));
+ }
+
+ // TODO: test other failures.
+ }
+
+ function testReadFieldInstance() {
+
+ }
+
+ function testUpdateFieldInstance() {
+ field_create_instance($this->instance_definition);
+ $field_type = field_info_field_types($this->field['type']);
+
+ // Check that basic changes are saved.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $instance['required'] = !$instance['required'];
+ $instance['weight']++;
+ $instance['label'] = $this->randomName();
+ $instance['description'] = $this->randomName();
+ $instance['settings']['test_instance_setting'] = $this->randomName();
+ $instance['widget']['settings']['test_widget_setting'] =$this->randomName();
+ $instance['display']['full']['settings']['test_formatter_setting'] = $this->randomName();
+ field_update_instance($instance);
+
+ $instance_new = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertEqual($instance['required'], $instance_new['required'], t('"required" change is saved'));
+ $this->assertEqual($instance['weight'], $instance_new['weight'], t('"weight" change is saved'));
+ $this->assertEqual($instance['label'], $instance_new['label'], t('"label" change is saved'));
+ $this->assertEqual($instance['description'], $instance_new['description'], t('"description" change is saved'));
+ $this->assertEqual($instance['widget']['settings']['test_widget_setting'], $instance_new['widget']['settings']['test_widget_setting'], t('Widget setting change is saved'));
+ $this->assertEqual($instance['display']['full']['settings']['test_formatter_setting'], $instance_new['display']['full']['settings']['test_formatter_setting'], t('Formatter setting change is saved'));
+
+ // Check that changing widget and formatter types updates the default settings.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $instance['widget']['type'] = 'test_field_widget_multiple';
+ $instance['display']['full']['type'] = 'field_test_multiple';
+ field_update_instance($instance);
+
+ $instance_new = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertEqual($instance['widget']['type'], $instance_new['widget']['type'] , t('Widget type change is saved.'));
+ $settings = (array)module_invoke($instance_new['widget']['module'], 'widget_settings', $instance_new['widget']['type']);
+ $this->assertIdentical($settings, array_intersect_key($instance_new['widget']['settings'], $settings) , t('Widget type change updates default settings.'));
+ $this->assertEqual($instance['display']['full']['type'], $instance_new['display']['full']['type'] , t('Formatter type change is saved.'));
+ $info = field_info_formatter_types($instance_new['display']['full']['type']);
+ $settings = $info['settings'];
+ $this->assertIdentical($settings, array_intersect_key($instance_new['display']['full']['settings'], $settings) , t('Changing formatter type updates default settings.'));
+
+ // Check that adding a new build mode is saved and gets default settings.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $instance['display']['teaser'] = array();
+ field_update_instance($instance);
+
+ $instance_new = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue(isset($instance_new['display']['teaser']), t('Display for the new build_mode has been written.'));
+ $this->assertIdentical($instance_new['display']['teaser']['type'], $field_type['default_formatter'], t('Default formatter for the new build_mode has been written.'));
+ $info = field_info_formatter_types($instance_new['display']['teaser']['type']);
+ $settings = $info['settings'];
+ $this->assertIdentical($settings, $instance_new['display']['teaser']['settings'] , t('Default formatter settings for the new build_mode have been written.'));
+
+ // TODO: test failures.
+ }
+
+ function testDeleteFieldInstance() {
+ // TODO: Test deletion of the data stored in the field also.
+ // Need to check that data for a 'deleted' field / instance doesn't get loaded
+ // Need to check data marked deleted is cleaned on cron (not implemented yet...)
+
+ // Create two instances for the same field so we can test that only one
+ // is deleted.
+ field_create_instance($this->instance_definition);
+ $this->another_instance_definition = $this->instance_definition;
+ $this->another_instance_definition['bundle'] .= '_another_bundle';
+ field_create_instance($this->another_instance_definition);
+
+ // Test that the first instance is not deleted, and then delete it.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($instance) && empty($instance['deleted']), t('A new field instance is not marked for deletion.'));
+ field_delete_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+
+ // Make sure the instance is marked as deleted when the instance is
+ // specifically loaded.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle'], array('include_deleted' => TRUE));
+ $this->assertTrue(!empty($instance['deleted']), t('A deleted field instance is marked for deletion.'));
+
+ // Try to load the instance normally and make sure it does not show up.
+ $instance = field_read_instance($this->instance_definition['field_name'], $this->instance_definition['bundle']);
+ $this->assertTrue(empty($instance), t('A deleted field instance is not loaded by default.'));
+
+ // Make sure the other field instance is not deleted.
+ $another_instance = field_read_instance($this->another_instance_definition['field_name'], $this->another_instance_definition['bundle']);
+ $this->assertTrue(!empty($another_instance) && empty($another_instance['deleted']), t('A non-deleted field instance is not marked for deletion.'));
+ }
+}
=== added directory 'modules/field/modules'
=== added directory 'modules/field/modules/field_sql_storage'
=== added file 'modules/field/modules/field_sql_storage/field_sql_storage.info'
--- modules/field/modules/field_sql_storage/field_sql_storage.info 1970-01-01 00:00:00 +0000
+++ modules/field/modules/field_sql_storage/field_sql_storage.info 2009-01-15 16:50:15 +0000
@@ -0,0 +1,7 @@
+; $Id$
+name = Field SQL storage
+description = Stores field data in an SQL database.
+package = Core - fields
+core = 7.x
+files[] = field_sql_storage.module
+files[] = field_sql_storage.install
=== added file 'modules/field/modules/field_sql_storage/field_sql_storage.install'
--- modules/field/modules/field_sql_storage/field_sql_storage.install 1970-01-01 00:00:00 +0000
+++ modules/field/modules/field_sql_storage/field_sql_storage.install 2009-01-15 16:50:15 +0000
@@ -0,0 +1,32 @@
+ 'Data storage for field '. $field['field_name'],
+ 'fields' => array(
+ 'entity' => array(
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'not null' => TRUE,
+ 'description' => 'The entity type this data is attached to',
+ ),
+ 'bundle' => array(
+ 'type' => 'varchar',
+ 'length' => 32,
+ 'not null' => TRUE,
+ 'default' => '',
+ 'description' => 'The field instance bundle to which this row belongs, used when deleting a field instance',
+ ),
+ 'deleted' => array(
+ 'type' => 'int',
+ 'size' => 'tiny',
+ 'not null' => TRUE,
+ 'default' => 0,
+ 'description' => 'A boolean indicating whether this data item has been deleted'
+ ),
+ 'entity_id' => array(
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ 'description' => 'The entity id this data is attached to',
+ ),
+ 'revision_id' => array(
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => FALSE,
+ 'description' => 'The entity revision id this data is attached to, or NULL if the entity type is not versioned',
+ ),
+ 'delta' => array(
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => TRUE,
+ 'description' => 'The sequence number for this data item, used for multi-value fields',
+ ),
+ ),
+ 'primary key' => array('entity', 'entity_id', 'deleted', 'delta'),
+ // TODO : index on 'bundle'
+ );
+
+ // Add field columns.
+ foreach ($field['columns'] as $attributes) {
+ $column_name = $attributes['column'];
+ unset($attributes['column']);
+ $current['fields'][$column_name] = $attributes;
+ }
+
+ // Construct the revision table. The primary key includes
+ // revision_id but not entity_id so that multiple revision loads can
+ // use the IN operator.
+ $revision = $current;
+ $revision['description'] = 'Revision archive storage for field '. $field['field_name'];
+ $revision['revision_id']['description'] = 'The entity revision id this data is attached to';
+ $revision['primary key'] = array('entity', 'revision_id', 'deleted', 'delta');
+
+ return array(
+ _field_sql_storage_tablename($field['field_name']) => $current,
+ _field_sql_storage_revision_tablename($field['field_name']) => $revision,
+ );
+}
+
+function field_sql_storage_create_table($field) {
+ $schema = _field_sql_storage_schema($field);
+ foreach ($schema as $name => $table) {
+ db_create_table($ret, $name, $table);
+ }
+}
+
+function field_sql_storage_delete_table($field_name) {
+ // Mark all data associated with the field for deletion.
+ $table = _field_sql_storage_tablename($field_name);
+ db_update($table)
+ ->fields(array('deleted' => 1))
+ ->execute();
+}
+
+/**
+ * Load field data for a set of objects from the database.
+ *
+ * @param $obj_type
+ * The entity type of objects being loaded, such as 'node' or
+ * 'user'.
+ * @param $objects
+ * The array of objects for which to load data. The objects
+ * referenced by this array will have the field data added to them
+ * directly.
+ * @param $age
+ * FIELD_LOAD_CURRENT to load the most recent revision for all
+ * fields, or FIELD_LOAD_REVISION to load the version indicated by
+ * each object.
+ * @return
+ * An array of field data for the objects, keyed by entity id, field
+ * name, and item delta number.
+ */
+function field_sql_storage_load($obj_type, $objects, $age) {
+ $load_current = $age == FIELD_LOAD_CURRENT;
+
+ // Gather ids needed for each field.
+ $field_ids = array();
+ $delta_count = array();
+ foreach ($objects as $obj) {
+ list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $obj);
+ foreach (field_info_instances($bundle) as $instance) {
+ $field_ids[$instance['field_name']][] = $load_current ? $id : $vid;
+ $delta_count[$id][$instance['field_name']] = 0;
+ }
+ }
+
+ $additions = array();
+ foreach ($field_ids as $field_name => $ids) {
+ $field = field_info_field($field_name);
+ $table = $load_current ? _field_sql_storage_tablename($field_name) : _field_sql_storage_revision_tablename($field_name);
+
+ $results = db_select($table, 't')
+ ->fields('t')
+ ->condition('entity', $obj_type)
+ ->condition($load_current ? 'entity_id' : 'revision_id', $ids, 'IN')
+ ->condition('deleted', 0)
+ ->orderBy('delta')
+ ->execute();
+
+ foreach ($results as $row) {
+ if ($field['cardinality'] == FIELD_CARDINALITY_UNLIMITED || $delta_count[$row->entity_id][$field_name] < $field['cardinality']) {
+ $item = array();
+ // For each column declared by the field, populate the item
+ // from the prefixed database column.
+ foreach ($field['columns'] as $column => $attributes) {
+ $item[$column] = $row->$attributes['column'];
+ }
+
+ // Add the item to the field values for the entity.
+ $additions[$row->entity_id][$field_name][] = $item;
+ $delta_count[$row->entity_id][$field_name]++;
+ }
+ }
+ }
+ return $additions;
+}
+
+function field_sql_storage_write($obj_type, $object, $update = FALSE) {
+ list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $object);
+
+ $instances = field_info_instances($bundle);
+ foreach ($instances as $instance) {
+ $field_name = $instance['field_name'];
+ $table_name = _field_sql_storage_tablename($field_name);
+ $revision_name = _field_sql_storage_revision_tablename($field_name);
+ $field = field_read_field($field_name);
+
+ // Leave the field untouched if $object comes with no $field_name property.
+ // Empty the field if $object->$field_name is NULL or an empty array.
+
+ // Function property_exists() is slower, so we catch the more frequent cases
+ // where it's an empty array with the faster isset().
+ if (isset($object->$field_name) || property_exists($object, $field_name)) {
+ // Delete and insert, rather than update, in case a value was added.
+ if ($update) {
+ db_delete($table_name)->condition('entity', $obj_type)->condition('entity_id', $id)->execute();
+ if (isset($vid)) {
+ db_delete($revision_name)->condition('entity', $obj_type)->condition('entity_id', $id)->condition('revision_id', $vid)->execute();
+ }
+ }
+
+ if ($object->$field_name) {
+ // Prepare the multi-insert query.
+ $columns = array('entity', 'entity_id', 'revision_id', 'bundle', 'delta');
+ foreach ($field['columns'] as $column => $attributes) {
+ $columns[] = $attributes['column'];
+ }
+ $query = db_insert($table_name)->fields($columns);
+ if (isset($vid)) {
+ $revision_query = db_insert($revision_name)->fields($columns);
+ }
+
+ $delta_count = 0;
+ foreach ($object->$field_name as $delta => $item) {
+ $record = array(
+ 'entity' => $obj_type,
+ 'entity_id' => $id,
+ 'revision_id' => $vid,
+ 'bundle' => $bundle,
+ 'delta' => $delta,
+ );
+ foreach ($field['columns'] as $column => $attributes) {
+ $record[$attributes['column']] = isset($item[$column]) ? $item[$column] : NULL;
+ }
+ $query->values($record);
+ if (isset($vid)) {
+ $revision_query->values($record);
+ }
+
+ if ($field['cardinality'] != FIELD_CARDINALITY_UNLIMITED && ++$delta_count == $field['cardinality']) {
+ break;
+ }
+ }
+
+ // Execute the insert.
+ $query->execute();
+ if (isset($vid)) {
+ $revision_query->execute();
+ }
+ }
+ }
+ }
+}
+
+/**
+ * Delete all field data for a single object. This function actually
+ * deletes the data from the database.
+ *
+ * @param $obj_type
+ * The entity type of the object being deleted, such as 'node' or
+ * 'user'.
+ * @param $object
+ * The object for which to delete field data.
+ */
+function field_sql_storage_delete($obj_type, $object) {
+ list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $object);
+
+ $instances = field_info_instances($bundle);
+ foreach ($instances as $instance) {
+ $field_name = $instance['field_name'];
+ $table_name = _field_sql_storage_tablename($field_name);
+ $revision_name = _field_sql_storage_revision_tablename($field_name);
+ db_delete($table_name)
+ ->condition('entity', $obj_type)
+ ->condition('entity_id', $id)
+ ->execute();
+ db_delete($revision_name)
+ ->condition('entity', $obj_type)
+ ->condition('entity_id', $id)
+ ->execute();
+ }
+}
+
+/**
+ * Delete field data for a single revision of a single object.
+ * Deleting the current (most recently written) revision is not
+ * allowed as has undefined results. This function actually deletes
+ * the data from the database.
+ *
+ * @param $obj_type
+ * The entity type of the object being deleted, such as 'node' or
+ * 'user'.
+ * @param $object
+ * The object for which to delete field data.
+ */
+function field_sql_storage_delete_revision($obj_type, $object) {
+ list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $object);
+
+ if (isset($vid)) {
+ $instances = field_info_instances($bundle);
+ foreach ($instances as $instance) {
+ $field_name = $instance['field_name'];
+ $revision_name = _field_sql_storage_revision_tablename($field_name);
+ db_delete($revision_name)
+ ->condition('entity', $obj_type)
+ ->condition('entity_id', $id)
+ ->condition('revision_id', $vid)
+ ->execute();
+ }
+ }
+}
+
+function field_sql_storage_delete_instance($field_name, $bundle) {
+ // Mark all data associated with the field for deletion.
+ $table_name = _field_sql_storage_tablename($field_name);
+ $revision_name = _field_sql_storage_revision_tablename($field_name);
+ db_update($table_name)
+ ->fields(array('deleted' => 1))
+ ->condition('bundle', $bundle)
+ ->execute();
+ db_update($revision_name)
+ ->fields(array('deleted' => 1))
+ ->condition('bundle', $bundle)
+ ->execute();
+}
+
+function field_sql_storage_rename_bundle($bundle_old, $bundle_new) {
+ $instances = field_info_instances($bundle_old);
+ foreach ($instances as $instance) {
+ $table_name = _field_sql_storage_tablename($instance['field_name']);
+ $revision_name = _field_sql_storage_revision_tablename($instance['field_name']);
+ db_update($table_name)
+ ->fields(array('bundle' => $bundle_new))
+ ->condition('bundle', $bundle_old)
+ ->execute();
+ db_update($revision_name)
+ ->fields(array('bundle' => $bundle_new))
+ ->condition('bundle', $bundle_old)
+ ->execute();
+ }
+}
\ No newline at end of file
=== added directory 'modules/field/modules/list'
=== added file 'modules/field/modules/list/list.info'
--- modules/field/modules/list/list.info 1970-01-01 00:00:00 +0000
+++ modules/field/modules/list/list.info 2009-01-15 16:50:15 +0000
@@ -0,0 +1,8 @@
+; $Id$
+name = List
+description = Defines list field types. Use with Optionwidgets to create selection lists.
+dependencies[] = field
+package = Core - fields
+core = 7.x
+
+files[]=list.module
=== added file 'modules/field/modules/list/list.module'
--- modules/field/modules/list/list.module 1970-01-01 00:00:00 +0000
+++ modules/field/modules/list/list.module 2009-01-15 16:50:16 +0000
@@ -0,0 +1,206 @@
+ array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'field_formatter_list_key' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_info().
+ */
+function list_field_info() {
+ return array(
+ 'list' => array(
+ 'label' => t('List'),
+ 'description' => t('This field stores numeric keys from key/value lists of allowed values where the key is a simple alias for the position of the value, i.e. 0|First option, 1|Second option, 2|Third option.'),
+ 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''),
+ 'default_widget' => 'option_widgets_select',
+ 'default_formatter' => 'list_default',
+ ),
+ 'list_boolean' => array(
+ 'label' => t('Boolean'),
+ 'description' => t('This field stores simple on/off or yes/no options.'),
+ 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''),
+ 'default_widget' => 'option_widgets_select',
+ 'default_formatter' => 'list_default',
+ ),
+ 'list_number' => array(
+ 'label' => t('List (numeric)'),
+ 'description' => t('This field stores keys from key/value lists of allowed numbers where the stored numeric key has significance and must be preserved, i.e. \'Lifetime in days\': 1|1 day, 7|1 week, 31|1 month.'),
+ 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''),
+ 'default_widget' => 'option_widgets_select',
+ 'default_formatter' => 'list_default',
+ ),
+ 'list_text' => array(
+ 'label' => t('List (text)'),
+ 'description' => t('This field stores keys from key/value lists of allowed values where the stored key has significance and must be a varchar, i.e. \'US States\': IL|Illinois, IA|Iowa, IN|Indiana'),
+ 'settings' => array('allowed_values' => '', 'allowed_values_function' => ''),
+ 'default_widget' => 'option_widgets_select',
+ 'default_formatter' => 'list_default',
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_schema().
+ */
+function list_field_columns($field) {
+ switch ($field['type']) {
+ case 'list_text':
+ $columns = array(
+ 'value' => array(
+ 'type' => 'varchar',
+ 'length' => 255,
+ 'not null' => FALSE,
+ ),
+ );
+ break;
+ case 'list_number':
+ $columns = array(
+ 'value' => array(
+ 'type' => 'float',
+ 'unsigned' => TRUE,
+ 'not null' => FALSE,
+ ),
+ );
+ break;
+ default:
+ $columns = array(
+ 'value' => array(
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => FALSE,
+ ),
+ );
+ break;
+ }
+ return $columns;
+}
+
+/**
+ * Implementation of hook_field_validate().
+ */
+function list_field_validate($obj_type, $object, $field, $instance, $items, $form) {
+ $allowed_values = list_allowed_values($field);
+ if (is_array($items)) {
+ foreach ($items as $delta => $item) {
+ $error_element = isset($item['_error_element']) ? $item['_error_element'] : '';
+ if (is_array($item) && isset($item['_error_element'])) unset($item['_error_element']);
+ if (!empty($item['value'])) {
+ if (count($allowed_values) && !array_key_exists($item['value'], $allowed_values)) {
+ form_set_error($error_element, t('%name: illegal value.', array('%name' => t($instance['label']))));
+ }
+ }
+ }
+ }
+}
+
+/**
+ * Implementation of hook_field_is_empty().
+ */
+function list_field_is_empty($item, $field) {
+ if (empty($item['value']) && (string)$item['value'] !== '0') {
+ return TRUE;
+ }
+ return FALSE;
+}
+
+/**
+ * Implementation of hook_field_formatter_info().
+ */
+function list_field_formatter_info() {
+ return array(
+ 'list_default' => array(
+ 'label' => t('Default'),
+ 'field types' => array('list', 'list_boolean', 'list_text', 'list_number'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'list_key' => array(
+ 'label' => t('Key'),
+ 'field types' => array('list', 'list_boolean', 'list_text', 'list_number'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Theme function for 'default' list field formatter.
+ */
+function theme_field_formatter_list_default($element) {
+ $field = field_info_field($element['#field_name']);
+ if (($allowed_values = list_allowed_values($field)) && isset($allowed_values[$element['#item']['value']])) {
+ return $allowed_values[$element['#item']['value']];
+ }
+ // If no match was found in allowed values, fall back to the key.
+ return $element['#item']['safe'];
+}
+
+/**
+ * Theme function for 'key' list field formatter.
+ */
+function theme_field_formatter_list_key($element) {
+ return $element['#item']['safe'];
+}
+
+/**
+ * Create an array of the allowed values for this field.
+ *
+ * Used by number and text fields, expects to find either
+ * a function that will return the correct value, or a string
+ * with keys and labels separated with '|' and with each
+ * new value on its own line.
+ */
+// TODO Rework this to create a method of selecting plugable allowed values lists.
+function list_allowed_values($field) {
+ static $allowed_values;
+
+ if (isset($allowed_values[$field['field_name']])) {
+ return $allowed_values[$field['field_name']];
+ }
+
+ $allowed_values[$field['field_name']] = array();
+
+ if (isset($field['settings']['allowed_values_function'])) {
+ $function = $field['settings']['allowed_values_function'];
+ if (drupal_function_exists($function)) {
+ $allowed_values[$field['field_name']] = $function($field);
+ }
+ }
+
+ if (empty($allowed_values[$field['field_name']]) && isset($field['settings']['allowed_values'])) {
+ $list = explode("\n", $field['settings']['allowed_values']);
+ $list = array_map('trim', $list);
+ $list = array_filter($list, 'strlen');
+ foreach ($list as $opt) {
+ // Sanitize the user input with a permissive filter.
+ $opt = field_filter_xss($opt);
+ if (strpos($opt, '|') !== FALSE) {
+ list($key, $value) = explode('|', $opt);
+ $allowed_values[$field['field_name']][$key] = (isset($value) && $value !=='') ? $value : $key;
+ }
+ else {
+ $allowed_values[$field['field_name']][$opt] = $opt;
+ }
+ }
+ }
+ return $allowed_values[$field['field_name']];
+}
=== added directory 'modules/field/modules/node_reference'
=== added file 'modules/field/modules/node_reference/node_reference.info'
--- modules/field/modules/node_reference/node_reference.info 1970-01-01 00:00:00 +0000
+++ modules/field/modules/node_reference/node_reference.info 2009-01-15 16:50:15 +0000
@@ -0,0 +1,9 @@
+; $Id$
+name = Node Reference
+description = Defines a field type for referencing one node from another.
+dependencies[] = field
+dependencies[] = text
+dependencies[] = option_widgets
+files[]=node_reference.module
+package = Core - fields
+core = 7.x
=== added file 'modules/field/modules/node_reference/node_reference.module'
--- modules/field/modules/node_reference/node_reference.module 1970-01-01 00:00:00 +0000
+++ modules/field/modules/node_reference/node_reference.module 2009-01-15 16:50:15 +0000
@@ -0,0 +1,797 @@
+ 'node_reference autocomplete',
+ 'page callback' => 'node_reference_autocomplete',
+ 'access arguments' => array('access content'),
+ 'type' => MENU_CALLBACK
+ );
+ return $items;
+}
+
+/**
+ * Implementation of hook_theme().
+ */
+function node_reference_theme() {
+ return array(
+ 'node_reference_select' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'node_reference_buttons' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'node_reference_autocomplete' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'field_formatter_node_reference_default' => array(
+ 'arguments' => array('element'),
+ ),
+ 'field_formatter_node_reference_plain' => array(
+ 'arguments' => array('element'),
+ ),
+ 'field_formatter_node_reference_full' => array(
+ 'arguments' => array('element'),
+ 'function' => 'theme_field_formatter_node_reference_node',
+ ),
+ 'field_formatter_node_reference_teaser' => array(
+ 'arguments' => array('element'),
+ 'function' => 'theme_field_formatter_node_reference_node',
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_info().
+ */
+function node_reference_field_info() {
+ return array(
+ 'node_reference' => array(
+ 'label' => t('Node reference'),
+ 'description' => t('This field stores the ID of a related node as an integer value.'),
+ 'settings' => array('referenceable_types'),
+ 'default_widget' => 'node_reference_autocomplete',
+ 'default_formatter' => 'node_reference_default',
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_settings().
+ */
+function node_reference_field_settings($op, $field) {
+ switch ($op) {
+
+ case 'database columns':
+ $columns = array(
+ 'nid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE),
+ );
+ return $columns;
+
+ }
+}
+
+/**
+ * Implementation of hook_field().
+ */
+function node_reference_field($op, $node, $field, &$items, $teaser, $page) {
+ switch ($op) {
+ // When preparing a translation, load any translations of existing references.
+ case 'prepare translation':
+ $addition = array();
+ $addition[$field['field_name']] = array();
+ if (isset($node->translation_source->$field['field_name']) && is_array($node->translation_source->$field['field_name'])) {
+ foreach ($node->translation_source->$field['field_name'] as $key => $reference) {
+ $reference_node = node_load($reference['nid']);
+ // Test if the referenced node type is translatable and, if so,
+ // load translations if the reference is not for the current language.
+ // We can assume the translation module is present because it invokes 'prepare translation'.
+ if (translation_supported_type($reference_node->type) && !empty($reference_node->language) && $reference_node->language != $node->language && $translations = translation_node_get_translations($reference_node->tnid)) {
+ // If there is a translation for the current language, use it.
+ $addition[$field['field_name']][] = array(
+ 'nid' => isset($translations[$node->language]) ? $translations[$node->language]->nid : $reference['nid'],
+ );
+ }
+ }
+ }
+ return $addition;
+
+ case 'validate':
+ // Extract nids to check.
+ $ids = array();
+ foreach ($items as $delta => $item) {
+ if (is_array($item) && !empty($item['nid']) && is_numeric($item['nid'])) {
+ $ids[] = $item['nid'];
+ }
+ }
+ $refs = _node_reference_potential_references($field, '', NULL, $ids);
+ foreach ($items as $delta => $item) {
+ if (is_array($item)) {
+ $error_element = isset($item['_error_element']) ? $item['_error_element'] : '';
+ if (is_array($item) && isset($item['_error_element'])) unset($item['_error_element']);
+ if (!empty($item['nid']) && !isset($refs[$item['nid']])) {
+ form_set_error($error_element, t("%name: this post can't be referenced.", array('%name' => t($field['widget']['label']))));
+ }
+ }
+ }
+ return $items;
+ }
+}
+
+/**
+ * Implementation of hook_field_is_empty().
+ */
+function node_reference_field_is_empty($item, $field) {
+ if (empty($item['nid'])) {
+ return TRUE;
+ }
+ return FALSE;
+}
+
+/**
+ * Implementation of hook_field_formatter_info().
+ */
+function node_reference_field_formatter_info() {
+ return array(
+ 'node_reference_default' => array(
+ 'label' => t('Title (link)'),
+ 'field types' => array('node_reference'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'node_reference_plain' => array(
+ 'label' => t('Title (no link)'),
+ 'field types' => array('node_reference'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'node_reference_full' => array(
+ 'label' => t('Full node'),
+ 'field types' => array('node_reference'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'node_reference_teaser' => array(
+ 'label' => t('Teaser'),
+ 'field types' => array('node_reference'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Theme function for 'default' node_reference field formatter.
+ */
+function theme_field_formatter_node_reference_default($element) {
+ $output = '';
+ if (!empty($element['#item']['nid']) && is_numeric($element['#item']['nid']) && ($title = _node_reference_titles($element['#item']['nid']))) {
+ $output = l($title, 'node/'. $element['#item']['nid']);
+ }
+ return $output;
+}
+
+/**
+ * Theme function for 'plain' node_reference field formatter.
+ */
+function theme_field_formatter_node_reference_plain($element) {
+ $output = '';
+ if (!empty($element['#item']['nid']) && is_numeric($element['#item']['nid']) && ($title = _node_reference_titles($element['#item']['nid']))) {
+ $output = check_plain($title);
+ }
+ return $output;
+}
+
+/**
+ * Proxy theme function for 'full' and 'teaser' node_reference field formatters.
+ */
+function theme_field_formatter_node_reference_node($element) {
+ static $recursion_queue = array();
+ $output = '';
+ if (!empty($element['#item']['nid']) && is_numeric($element['#item']['nid'])) {
+ $node = $element['#node'];
+ $field = field_fields($element['#field_name'], $element['#type_name']);
+ // If no 'referencing node' is set, we are starting a new 'reference thread'
+ if (!isset($node->referencing_node)) {
+ $recursion_queue = array();
+ }
+ $recursion_queue[] = $node->nid;
+ if (in_array($element['#item']['nid'], $recursion_queue)) {
+ // Prevent infinite recursion caused by reference cycles:
+ // if the node has already been rendered earlier in this 'thread',
+ // we fall back to 'default' (node title) formatter.
+ return theme('node_reference_formatter_default', $element);
+ }
+ if ($referenced_node = node_load($element['#item']['nid'])) {
+ $referenced_node->referencing_node = $node;
+ $referenced_node->referencing_field = $field;
+ _node_reference_titles($element['#item']['nid'], $referenced_node->title);
+ $output = node_view($referenced_node, $element['#formatter'] == 'teaser');
+ }
+ }
+ return $output;
+}
+
+/**
+ * Helper function for formatters.
+ *
+ * Store node titles collected in the curent request.
+ */
+function _node_reference_titles($nid, $known_title = NULL) {
+ static $titles = array();
+ if (!isset($titles[$nid])) {
+ $title = $known_title ? $known_title : db_result(db_query("SELECT title FROM {node} WHERE nid=%d", $nid));
+ $titles[$nid] = $title ? $title : '';
+ }
+ return $titles[$nid];
+}
+
+/**
+ * Implementation of hook_field_widget_info().
+ *
+ * We need custom handling of multiple values for the node_reference_select
+ * widget because we need to combine them into a options list rather
+ * than display multiple elements.
+ *
+ * We will use the Field module's default handling for default value.
+ *
+ * Callbacks can be omitted if default handing is used.
+ * They're included here just so this module can be used
+ * as an example for custom modules that might do things
+ * differently.
+ */
+function node_reference_field_widget_info() {
+ return array(
+ 'node_reference_select' => array(
+ 'label' => t('Select list'),
+ 'field types' => array('node_reference'),
+ 'settings' => array('autocomplete_match'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'node_reference_buttons' => array(
+ 'label' => t('Check boxes/radio buttons'),
+ 'field types' => array('node_reference'),
+ 'settings' => array('autocomplete_match'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'node_reference_autocomplete' => array(
+ 'label' => t('Autocomplete text field'),
+ 'field types' => array('node_reference'),
+ 'settings' => array('autocomplete_match'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Implementation of FAPI hook_elements().
+ *
+ * Any FAPI callbacks needed for individual widgets can be declared here,
+ * and the element will be passed to those callbacks for processing.
+ *
+ * Drupal will automatically theme the element using a theme with
+ * the same name as the hook_elements key.
+ *
+ * Autocomplete_path is not used by text_widget but other widgets can use it
+ * (see node_reference and userreference).
+ */
+function node_reference_elements() {
+ return array(
+ 'node_reference_select' => array(
+ '#input' => TRUE,
+ '#columns' => array('uid'), '#delta' => 0,
+ '#process' => array('node_reference_select_process'),
+ ),
+ 'node_reference_buttons' => array(
+ '#input' => TRUE,
+ '#columns' => array('uid'), '#delta' => 0,
+ '#process' => array('node_reference_buttons_process'),
+ ),
+ 'node_reference_autocomplete' => array(
+ '#input' => TRUE,
+ '#columns' => array('name'), '#delta' => 0,
+ '#process' => array('node_reference_autocomplete_process'),
+ '#autocomplete_path' => FALSE,
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_widget_settings().
+ */
+function node_reference_field_widget_settings($op, $widget) {
+ switch ($op) {
+ case 'form':
+ $form = array();
+ $match = isset($widget['autocomplete_match']) ? $widget['autocomplete_match'] : 'contains';
+ if ($widget['type'] == 'node_reference_autocomplete') {
+ $form['autocomplete_match'] = array(
+ '#type' => 'select',
+ '#title' => t('Autocomplete matching'),
+ '#default_value' => $match,
+ '#options' => array(
+ 'starts_with' => t('Starts with'),
+ 'contains' => t('Contains'),
+ ),
+ '#description' => t('Select the method used to collect autocomplete suggestions. Note that Contains can cause performance issues on sites with thousands of nodes.'),
+ );
+ }
+ else {
+ $form['autocomplete_match'] = array('#type' => 'hidden', '#value' => $match);
+ }
+ return $form;
+ }
+}
+
+/**
+ * Implementation of hook_field_widget().
+ *
+ * Attach a single form element to the form. It will be built out and
+ * validated in the callback(s) listed in hook_elements. We build it
+ * out in the callbacks rather than here in hook_widget so it can be
+ * plugged into any module that can provide it with valid
+ * $field information.
+ *
+ * Field module will set the weight, field name and delta values
+ * for each form element.
+ *
+ * If there are multiple values for this field, the field module will
+ * call this function as many times as needed.
+ *
+ * @param $form
+ * the entire form array, $form['#node'] holds node information
+ * @param $form_state
+ * the form_state, $form_state['values'][$field['field_name']]
+ * holds the field's form values.
+ * @param $instance
+ * the field instance array
+ * @param $items
+ * array of default values for this field
+ * @param $delta
+ * the order of this item in the array of subelements (0, 1, 2, etc)
+ *
+ * @return
+ * the form item for a single element for this field
+ */
+function node_reference_field_widget(&$form, &$form_state, $instance, $items, $delta = 0) {
+ switch ($instance['widget']['type']) {
+ case 'node_reference_select':
+ $element = array(
+ '#type' => 'node_reference_select',
+ '#default_value' => $items,
+ );
+ break;
+
+ case 'node_reference_buttons':
+ $element = array(
+ '#type' => 'node_reference_buttons',
+ '#default_value' => $items,
+ );
+ break;
+
+ case 'node_reference_autocomplete':
+ $element = array(
+ '#type' => 'node_reference_autocomplete',
+ '#default_value' => isset($items[$delta]) ? $items[$delta] : NULL,
+ '#value_callback' => 'node_reference_autocomplete_value',
+ );
+ break;
+ }
+ return $element;
+}
+
+/**
+ * Value for a node_reference autocomplete element.
+ *
+ * Substitute in the node title for the node nid.
+ */
+function node_reference_autocomplete_value($element, $edit = FALSE) {
+ $field_key = $element['#columns'][0];
+ if (!empty($element['#default_value'][$field_key])) {
+ $nid = $element['#default_value'][$field_key];
+ $value = db_result(db_query(db_rewrite_sql('SELECT n.title FROM {node} n WHERE n.nid = %d'), $nid));
+ $value .= ' [nid:'. $nid .']';
+ return array($field_key => $value);
+ }
+ return array($field_key => NULL);
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function node_reference_select_process($element, $edit, $form_state, $form) {
+ // The node_reference_select widget doesn't need to create its own
+ // element, it can wrap around the optionwidgets_select element.
+ // This will create a new, nested instance of the field.
+ // Add a validation step where the value can be unwrapped.
+ $field_key = $element['#columns'][0];
+ $element[$field_key] = array(
+ '#type' => 'optionwidgets_select',
+ '#default_value' => isset($element['#value']) ? $element['#value'] : '',
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#required' => $element['#required'],
+ '#description' => $element['#description'],
+ '#field_name' => $element['#field_name'],
+ '#type_name' => $element['#type_name'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+ if (empty($element[$field_key]['#element_validate'])) {
+ $element[$field_key]['#element_validate'] = array();
+ }
+ array_unshift($element[$field_key]['#element_validate'], 'node_reference_optionwidgets_validate');
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function node_reference_buttons_process($element, $edit, $form_state, $form) {
+ // The node_reference_select widget doesn't need to create its own
+ // element, it can wrap around the optionwidgets_select element.
+ // This will create a new, nested instance of the field.
+ // Add a validation step where the value can be unwrapped.
+ $field_key = $element['#columns'][0];
+ $element[$field_key] = array(
+ '#type' => 'optionwidgets_buttons',
+ '#default_value' => isset($element['#value']) ? $element['#value'] : '',
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#required' => $element['#required'],
+ '#description' => $element['#description'],
+ '#field_name' => $element['#field_name'],
+ '#type_name' => $element['#type_name'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+ if (empty($element[$field_key]['#element_validate'])) {
+ $element[$field_key]['#element_validate'] = array();
+ }
+ array_unshift($element[$field_key]['#element_validate'], 'node_reference_optionwidgets_validate');
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ */
+function node_reference_autocomplete_process($element, $edit, $form_state, $form) {
+
+ // The node_reference autocomplete widget doesn't need to create its own
+ // element, it can wrap around the text_textfield element and add an autocomplete
+ // path and some extra processing to it.
+ // Add a validation step where the value can be unwrapped.
+ $field_key = $element['#columns'][0];
+
+ $element[$field_key] = array(
+ '#type' => 'text_textfield',
+ '#default_value' => isset($element['#value']) ? $element['#value'] : '',
+ '#autocomplete_path' => 'node_reference/autocomplete/'. $element['#field_name'],
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#required' => $element['#required'],
+ '#description' => $element['#description'],
+ '#field_name' => $element['#field_name'],
+ '#type_name' => $element['#type_name'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+ if (empty($element[$field_key]['#element_validate'])) {
+ $element[$field_key]['#element_validate'] = array();
+ }
+ array_unshift($element[$field_key]['#element_validate'], 'node_reference_autocomplete_validate');
+
+ // Used so that hook_field('validate') knows where to flag an error.
+ $element['_error_element'] = array(
+ '#type' => 'value',
+ // Wrapping the element around a text_textfield element creates a
+ // nested element, so the final id will look like 'field-name-0-nid-nid'.
+ '#value' => implode('][', array_merge($element['#parents'], array($field_key, $field_key))),
+ );
+ return $element;
+}
+
+/**
+ * Validate a select/buttons element.
+ *
+ * Remove the wrapper layer and set the right element's value.
+ * We don't know exactly where this element is, so we drill down
+ * through the element until we get to our key.
+ *
+ * We use $form_state['values'] instead of $element['#value']
+ * to be sure we have the most accurate value when other modules
+ * like optionwidgets are using #element_validate to alter the value.
+ */
+function node_reference_optionwidgets_validate($element, &$form_state) {
+ $field_key = $element['#columns'][0];
+
+ $value = $form_state['values'];
+ $new_parents = array();
+ foreach ($element['#parents'] as $parent) {
+ $value = $value[$parent];
+ // Use === to be sure we get right results if parent is a zero (delta) value.
+ if ($parent === $field_key) {
+ $element['#parents'] = $new_parents;
+ form_set_value($element, $value, $form_state);
+ break;
+ }
+ $new_parents[] = $parent;
+ }
+}
+
+/**
+ * Validate an autocomplete element.
+ *
+ * Remove the wrapper layer and set the right element's value.
+ * This will move the nested value at 'field-name-0-nid-nid'
+ * back to its original location, 'field-name-0-nid'.
+ */
+function node_reference_autocomplete_validate($element, &$form_state) {
+ $field_name = $element['#field_name'];
+ $type_name = $element['#type_name'];
+ $field = field_fields($field_name, $type_name);
+ $field_key = $element['#columns'][0];
+ $delta = $element['#delta'];
+ $value = $element['#value'][$field_key];
+ $nid = NULL;
+ if (!empty($value)) {
+ preg_match('/^(?:\s*|(.*) )?\[\s*nid\s*:\s*(\d+)\s*\]$/', $value, $matches);
+ if (!empty($matches)) {
+ // Explicit [nid:n].
+ list(, $title, $nid) = $matches;
+ if (!empty($title) && ($n = node_load($nid)) && $title != $n->title) {
+ form_error($element[$field_key], t('%name: title mismatch. Please check your selection.', array('%name' => t($field['widget']['label']))));
+ }
+ }
+ else {
+ // No explicit nid.
+ $reference = _node_reference_potential_references($field, $value, 'equals', NULL, 1);
+ if (empty($reference)) {
+ form_error($element[$field_key], t('%name: found no valid post with that title.', array('%name' => t($field['widget']['label']))));
+ }
+ else {
+ // TODO:
+ // the best thing would be to present the user with an additional form,
+ // allowing the user to choose between valid candidates with the same title
+ // ATM, we pick the first matching candidate...
+ $nid = key($reference);
+ }
+ }
+ }
+ form_set_value($element, $nid, $form_state);
+}
+
+/**
+ * Implementation of hook_allowed_values().
+ */
+function node_reference_allowed_values($field) {
+ $references = _node_reference_potential_references($field);
+
+ $options = array();
+ foreach ($references as $key => $value) {
+ // Views theming runs check_plain (htmlentities) on the values.
+ // We reverse that with html_entity_decode.
+ $options[$key] = html_entity_decode(strip_tags($value['rendered']), ENT_QUOTES);
+ }
+ return $options;
+}
+
+/**
+ * Fetch an array of all candidate referenced nodes.
+ *
+ * This info is used in various places (aloowed values, autocomplete results,
+ * input validation...). Some of them only need the nids, others nid + titles,
+ * others yet nid + titles + rendered row (for display in widgets).
+ * The array we return contains all the potentially needed information, and lets
+ * consumers use the parts they actually need.
+ *
+ * @param $field
+ * The field description.
+ * @param $string
+ * Optional string to filter titles on (used by autocomplete).
+ * @param $match
+ * Operator to match filtered name against, can be any of:
+ * 'contains', 'equals', 'starts_with'
+ * @param $ids
+ * Optional node ids to lookup (the $string and $match arguments will be
+ * ignored).
+ * @param $limit
+ * If non-zero, limit the size of the result set.
+ *
+ * @return
+ * An array of valid nodes in the form:
+ * array(
+ * nid => array(
+ * 'title' => The node title,
+ * 'rendered' => The text to display in widgets (can be HTML)
+ * ),
+ * ...
+ * )
+ */
+function _node_reference_potential_references($field, $string = '', $match = 'contains', $ids = array(), $limit = NULL) {
+ static $results = array();
+
+ // Create unique id for static cache.
+ $cid = $field['field_name'] .':'. $match .':'. ($string !== '' ? $string : implode('-', $ids)) .':'. $limit;
+ if (!isset($results[$cid])) {
+ $references = FALSE;
+ if ($references === FALSE) {
+ $references = _node_reference_potential_references_standard($field, $string, $match, $ids, $limit);
+ }
+
+ // Store the results.
+ $results[$cid] = $references;
+ }
+
+ return $results[$cid];
+}
+
+/**
+ * Helper function for _node_reference_potential_references():
+ * referenceable nodes defined by content types.
+ */
+function _node_reference_potential_references_standard($field, $string = '', $match = 'contains', $ids = array(), $limit = NULL) {
+ $related_types = array();
+ $where = array();
+ $args = array();
+
+ if (is_array($field['referenceable_types'])) {
+ foreach (array_filter($field['referenceable_types']) as $related_type) {
+ $related_types[] = "n.type = '%s'";
+ $args[] = $related_type;
+ }
+ }
+
+ $where[] = implode(' OR ', $related_types);
+
+ if (!count($related_types)) {
+ return array();
+ }
+
+ if ($string !== '') {
+ $match_operators = array(
+ 'contains' => "LIKE '%%%s%%'",
+ 'equals' => "= '%s'",
+ 'starts_with' => "LIKE '%s%%'",
+ );
+ $where[] = 'n.title '. (isset($match_operators[$match]) ? $match_operators[$match] : $match_operators['contains']);
+ $args[] = $string;
+ }
+ elseif ($ids) {
+ $where[] = 'n.nid IN (' . db_placeholders($ids) . ')';
+ $args = array_merge($args, $ids);
+ }
+
+ $where_clause = $where ? 'WHERE ('. implode(') AND (', $where) .')' : '';
+ $sql = db_rewrite_sql("SELECT n.nid, n.title AS node_title, n.type AS node_type FROM {node} n $where_clause ORDER BY n.title, n.type");
+ $result = $limit ? db_query_range($sql, $args, 0, $limit) : db_query($sql, $args);
+ $references = array();
+ while ($node = db_fetch_object($result)) {
+ $references[$node->nid] = array(
+ 'title' => $node->node_title,
+ 'rendered' => $node->node_title,
+ );
+ }
+
+ return $references;
+}
+
+/**
+ * Menu callback; Retrieve a pipe delimited string of autocomplete suggestions for existing users
+ */
+function node_reference_autocomplete($field_name, $string = '') {
+ $fields = content_fields();
+ $field = $fields[$field_name];
+ $match = isset($field['widget']['autocomplete_match']) ? $field['widget']['autocomplete_match'] : 'contains';
+ $matches = array();
+
+ $references = _node_reference_potential_references($field, $string, $match, array(), 10);
+ foreach ($references as $id => $row) {
+ // Add a class wrapper for a few required CSS overrides.
+ $matches[$row['title'] ." [nid:$id]"] = ''. $row['rendered'] . '
';
+ }
+ drupal_json($matches);
+}
+
+/**
+ * Implementation of hook_node_types.
+ */
+function node_reference_node_type($op, $info) {
+ switch ($op) {
+ case 'update':
+ // Reflect type name changes to the 'referenceable types' settings.
+ if (!empty($info->old_type) && $info->old_type != $info->type) {
+ $fields = field_info_fields();
+ foreach ($fields as $field_name => $field) {
+ if ($field['type'] == 'node_reference' && isset($field['referenceable_types'][$info->old_type])) {
+ $field['referenceable_types'][$info->type] = empty($field['referenceable_types'][$info->old_type]) ? 0 : $info->type;
+ unset($field['referenceable_types'][$info->old_type]);
+ content_field_instance_update($field);
+ }
+ }
+ }
+ break;
+ }
+}
+
+/**
+ * Theme preprocess function.
+ *
+ * Allows specific node templates for nodes displayed as values of a
+ * node_reference field with the 'full node' / 'teaser' formatters.
+ */
+function node_reference_preprocess_node(&$vars) {
+ // The 'referencing_field' attribute of the node is added by the 'teaser'
+ // and 'full node' formatters.
+ if (!empty($vars['node']->referencing_field)) {
+ $node = $vars['node'];
+ $field = $node->referencing_field;
+ $vars['template_files'][] = 'node-node_reference';
+ $vars['template_files'][] = 'node-node_reference-'. $field['field_name'];
+ $vars['template_files'][] = 'node-node_reference-'. $node->type;
+ $vars['template_files'][] = 'node-node_reference-'. $field['field_name'] .'-'. $node->type;
+ }
+}
+
+/**
+ * FAPI theme for an individual elements.
+ *
+ * The textfield or select is already rendered by the
+ * textfield or select themes and the html output
+ * lives in $element['#children']. Override this theme to
+ * make custom changes to the output.
+ *
+ * $element['#field_name'] contains the field name
+ * $element['#delta] is the position of this element in the group
+ */
+function theme_node_reference_select($element) {
+ return $element['#children'];
+}
+
+function theme_node_reference_buttons($element) {
+ return $element['#children'];
+}
+
+function theme_node_reference_autocomplete($element) {
+ return $element['#children'];
+}
\ No newline at end of file
=== added directory 'modules/field/modules/number'
=== added file 'modules/field/modules/number/number.info'
--- modules/field/modules/number/number.info 1970-01-01 00:00:00 +0000
+++ modules/field/modules/number/number.info 2009-01-15 16:50:15 +0000
@@ -0,0 +1,8 @@
+; $Id$
+name = Number
+description = Defines numeric field types.
+dependencies[] = field
+package = Core - fields
+core = 7.x
+
+files[]=number.module
=== added file 'modules/field/modules/number/number.module'
--- modules/field/modules/number/number.module 1970-01-01 00:00:00 +0000
+++ modules/field/modules/number/number.module 2009-01-15 16:50:16 +0000
@@ -0,0 +1,424 @@
+ array('arguments' => array('element' => NULL)),
+ 'field_formatter_number_integer' => array('arguments' => array('element' => NULL), 'function' => 'theme_field_formatter_number'),
+ 'field_formatter_number_decimal' => array('arguments' => array('element' => NULL), 'function' => 'theme_field_formatter_number'),
+ 'field_formatter_number_unformatted' => array('arguments' => array('element' => NULL)),
+ );
+}
+
+/**
+ * Implementation of hook_field_info().
+ */
+function number_field_info() {
+ return array(
+ 'number_integer' => array(
+ 'label' => t('Integer'),
+ 'description' => t('This field stores a number in the database as an integer.'),
+ 'instance_settings' => array('min' => '', 'max' => '', 'prefix' => '', 'suffix' => ''),
+ 'default_widget' => 'number',
+ 'default_formatter' => 'number_integer',
+ ),
+ 'number_decimal' => array(
+ 'label' => t('Decimal'),
+ 'description' => t('This field stores a number in the database in a fixed decimal format.'),
+ 'settings' => array('precision' => 10, 'scale' => 2, 'decimal' => '.'),
+ 'instance_settings' => array('min' => '', 'max' => '', 'prefix' => '', 'suffix' => ''),
+ 'default_widget' => 'number',
+ 'default_formatter' => 'number_integer',
+ ),
+ 'number_float' => array(
+ 'label' => t('Float'),
+ 'description' => t('This field stores a number in the database in a floating point format.'),
+ 'instance_settings' => array('min' => '', 'max' => '', 'prefix' => '', 'suffix' => ''),
+ 'default_widget' => 'number',
+ 'default_formatter' => 'number_integer',
+ ),
+ );
+}
+
+function number_field_columns($field) {
+ switch ($field['type']) {
+ case 'number_integer' :
+ $colums = array(
+ 'value' => array(
+ 'type' => 'int',
+ 'not null' => FALSE
+ ),
+ );
+ break;
+
+ case 'number_float' :
+ $colums = array(
+ 'value' => array(
+ 'type' => 'float',
+ 'not null' => FALSE
+ ),
+ );
+ break;
+
+ case 'number_decimal' :
+ $colums = array(
+ 'value' => array(
+ 'type' => 'numeric',
+ 'precision' => $field['settings']['precision'],
+ 'scale' => $field['settings']['scale'],
+ 'not null' => FALSE
+ ),
+ );
+ break;
+ }
+ return $colums;
+}
+
+/**
+ * Implementation of hook_field_validate().
+ */
+function number_field_validate($obj_type, $node, $field, $instance, &$items, $form) {
+ if (is_array($items)) {
+ foreach ($items as $delta => $item) {
+ $error_element = isset($item['_error_element']) ? $item['_error_element'] : '';
+ if (is_array($item) && isset($item['_error_element'])) unset($item['_error_element']);
+ if ($item['value'] != '') {
+ if (is_numeric($instance['settings']['min']) && $item['value'] < $instance['settings']['min']) {
+ form_set_error($error_element, t('%name: the value may be no smaller than %min.', array('%name' => t($instance['label']), '%min' => $instance['settings']['min'])));
+ }
+ if (is_numeric($instance['settings']['max']) && $item['value'] > $instance['settings']['max']) {
+ form_set_error($error_element, t('%name: the value may be no larger than %max.', array('%name' => t($instance['label']), '%max' => $instance['settings']['max'])));
+ }
+ }
+ }
+ }
+}
+
+/**
+ * Implementation of hook_content_is_empty().
+ */
+function number_field_is_empty($item, $field) {
+ if (empty($item['value']) && (string)$item['value'] !== '0') {
+ return TRUE;
+ }
+ return FALSE;
+}
+
+/**
+ * Implementation of hook_field_formatter_info().
+ */
+function number_field_formatter_info() {
+ return array(
+ 'number_integer' => array(
+ 'label' => t('default'),
+ 'field types' => array('number_integer'),
+ 'settings' => array(
+ 'thousand_separator' => ' ',
+ 'decimal_separator' => '.',
+ 'scale' => 0,
+ 'prefix_suffix' => TRUE,
+ ),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'number_decimal' => array(
+ 'label' => t('default'),
+ 'field types' => array('number_decimal', 'number_float'),
+ 'settings' => array(
+ 'thousand_separator' => ' ',
+ 'decimal_separator' => '.',
+ 'scale' => 2,
+ 'prefix_suffix' => TRUE,
+ ),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'number_unformatted' => array(
+ 'label' => t('unformatted'),
+ 'field types' => array('number_integer', 'number_decimal', 'number_float'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Theme function for 'unformatted' number field formatter.
+ */
+function theme_field_formatter_number_unformatted($element) {
+ return $element['#item']['value'];
+}
+
+/**
+ * Proxy theme function for number field formatters.
+ */
+function theme_field_formatter_number($element) {
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ $value = $element['#item']['value'];
+ $settings = $element['#settings'];
+ $formatter_type = $element['#formatter'];
+
+ if (empty($value) && $value !== '0') {
+ return '';
+ }
+
+ $output = number_format($value, $settings['scale'], $settings['decimal_separator'], $settings['thousand_separator']);
+
+ if ($settings['prefix_suffix']) {
+ $prefixes = isset($instance['settings']['prefix']) ? explode('|', check_plain($instance['settings']['prefix'])) : array(0 => '');
+ $suffixes = isset($instance['settings']['suffix']) ? explode('|', check_plain($instance['settings']['suffix'])) : array(0 => '');
+ $prefix = (count($prefixes) > 1) ? format_plural($value, $prefixes[0], $prefixes[1]) : $prefixes[0];
+ $suffix = (count($suffixes) > 1) ? format_plural($value, $suffixes[0], $suffixes[1]) : $suffixes[0];
+ $output = $prefix . $output . $suffix;
+ }
+
+ return $output;
+}
+
+/**
+ * Implementation of hook_field_widget_info().
+ *
+ * Here we indicate that the content module will handle
+ * the default value and multiple values for these widgets.
+ *
+ * Callbacks can be omitted if default handing is used.
+ * They're included here just so this module can be used
+ * as an example for custom modules that might do things
+ * differently.
+ */
+function number_field_widget_info() {
+ return array(
+ 'number' => array(
+ 'label' => t('Text field'),
+ 'field types' => array('number_integer', 'number_decimal', 'number_float'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Implementation of FAPI hook_elements().
+ *
+ * Any FAPI callbacks needed for individual widgets can be declared here,
+ * and the element will be passed to those callbacks for processing.
+ *
+ * Drupal will automatically theme the element using a theme with
+ * the same name as the hook_elements key.
+ *
+ * Includes a regex to check for valid values as an additional parameter
+ * the validator can use. The regex can be overridden if necessary.
+ */
+function number_elements() {
+ return array(
+ 'number' => array(
+ '#input' => TRUE,
+ '#columns' => array('value'), '#delta' => 0,
+ '#process' => array('number_process'),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_widget().
+ *
+ * Attach a single form element to the form. It will be built out and
+ * validated in the callback(s) listed in hook_elements. We build it
+ * out in the callbacks rather than here in hook_widget so it can be
+ * plugged into any module that can provide it with valid
+ * $field information.
+ *
+ * Content module will set the weight, field name and delta values
+ * for each form element. This is a change from earlier CCK versions
+ * where the widget managed its own multiple values.
+ *
+ * If there are multiple values for this field, the content module will
+ * call this function as many times as needed.
+ *
+ * @param $form
+ * the entire form array, $form['#node'] holds node information
+ * @param $form_state
+ * the form_state, $form_state['values'] holds the form values.
+ * @param $instance
+ * the field instance array
+ * @param $delta
+ * the order of this item in the array of subelements (0, 1, 2, etc)
+ *
+ * @return
+ * the form item for a single element for this field
+ */
+function number_field_widget(&$form, &$form_state, $instance, $items, $delta = 0) {
+ $element = array(
+ '#type' => $instance['widget']['type'],
+ '#default_value' => isset($items[$delta]) ? $items[$delta] : NULL,
+ );
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function number_process($element, $edit, $form_state, $form) {
+ $field_name = $element['#field_name'];
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ $field_key = $element['#columns'][0];
+
+ $value = isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : '';
+ if ($field['type'] == 'number_decimal') {
+ $value = str_replace('.', $field['settings']['decimal'], $value);
+ }
+
+ $element[$field_key] = array(
+ '#type' => 'textfield',
+ '#default_value' => $value,
+ // Need to allow a slightly larger size that the field length to allow
+ // for some configurations where all characters won't fit in input field.
+ '#size' => $field['type'] == 'number_decimal' ? $field['settings']['precision'] + 2 : 12,
+ '#maxlength' => $field['type'] == 'number_decimal' ? $field['settings']['precision'] : 10,
+ '#attributes' => array('class' => 'number'),
+ // The following values were set by the content module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#description' => $element['#description'],
+ '#required' => $element['#required'],
+ '#field_name' => $element['#field_name'],
+ '#bundle' => $element['#bundle'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+
+ if (!empty($instance['settings']['prefix'])) {
+ $prefixes = explode('|', $instance['settings']['prefix']);
+ $element[$field_key]['#field_prefix'] = array_pop($prefixes);
+ }
+ if (!empty($instance['settings']['suffix'])) {
+ $suffixes = explode('|', $instance['settings']['suffix']);
+ $element[$field_key]['#field_suffix'] = array_pop($suffixes);
+ }
+
+ // Make sure we don't wipe out element validation added elsewhere.
+ if (empty($element['#element_validate'])) {
+ $element['#element_validate'] = array();
+ }
+ switch ($field['type']) {
+ case 'number_float':
+ $element['#element_validate'][] = 'number_float_validate';
+ break;
+ case 'number_integer':
+ $element['#element_validate'][] = 'number_integer_validate';
+ break;
+ case 'number_decimal':
+ $element['#element_validate'][] = 'number_decimal_validate';
+ break;
+ }
+
+ // Used so that hook_field('validate') knows where to flag an error.
+ $element['_error_element'] = array(
+ '#type' => 'value',
+ '#value' => implode('][', array_merge($element['#parents'], array($field_key))),
+ );
+
+ return $element;
+}
+
+/**
+ * FAPI validation of an individual float element.
+ */
+function number_float_validate($element, &$form_state) {
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ $field_key = $element['#columns'][0];
+ $value = $element['#value'][$field_key];
+
+ if (($element[$field_key]['#required'] || !empty($value))) {
+ $start = $value;
+ $value = preg_replace('@[^-0-9\.]@', '', $value);
+ if ($start != $value) {
+ $error_field = implode('][', $element['#parents']) .']['. $field_key;
+ form_set_error($error_field, t('Only numbers and decimals are allowed in %field.', array('%field' => t($instance['label']))));
+ }
+ else {
+ form_set_value($element[$field_key], $value, $form_state);
+ }
+ }
+}
+
+/**
+ * FAPI validation of an individual integer element.
+ */
+function number_integer_validate($element, &$form_state) {
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ $field_key = $element['#columns'][0];
+ $value = $element['#value'][$field_key];
+
+ if (($element[$field_key]['#required'] || !empty($value))) {
+ $start = $value;
+ $value = preg_replace('@[^-0-9]@', '', $value);
+ if ($start != $value) {
+ $error_field = implode('][', $element['#parents']) .']['. $field_key;
+ form_set_error($error_field, t('Only numbers are allowed in %field.', array('%field' => t($instance['label']))));
+ }
+ else {
+ form_set_value($element[$field_key], $value, $form_state);
+ }
+ }
+}
+
+/**
+ * FAPI validation of an individual decimal element.
+ */
+function number_decimal_validate($element, &$form_state) {
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ $field_key = $element['#columns'][0];
+ $value = $element['#value'][$field_key];
+
+ if (($element[$field_key]['#required'] || !empty($value))) {
+ $start = $value;
+ $value = preg_replace('@[^-0-9\\'. $field['settings']['decimal'] .']@', '', $value);
+ if ($start != $value) {
+ $error_field = implode('][', $element['#parents']) .']['. $field_key;
+ form_set_error($error_field, t('Only numbers and the decimal character (%decimal) are allowed in %field.', array('%decimal' => $field['settings']['decimal'], '%field' => t($instance['label']))));
+ }
+ else {
+ $value = str_replace($field['settings']['decimal'], '.', $value);
+ $value = round($value, $field['settings']['scale']);
+ form_set_value($element[$field_key], $value, $form_state);
+ }
+ }
+}
+
+/**
+ * FAPI theme for an individual number element.
+ *
+ * The textfield is already rendered by the textfield
+ * theme and the HTML output lives in $element['#children'].
+ * Override this theme to make custom changes to the output.
+ *
+ * $element['#field_name'] contains the field name
+ * $element['#delta] is the position of this element in the group
+ */
+function theme_number($element) {
+ return $element['#children'];
+}
\ No newline at end of file
=== added directory 'modules/field/modules/option_widgets'
=== added file 'modules/field/modules/option_widgets/option_widgets.info'
--- modules/field/modules/option_widgets/option_widgets.info 1970-01-01 00:00:00 +0000
+++ modules/field/modules/option_widgets/option_widgets.info 2009-01-15 16:50:16 +0000
@@ -0,0 +1,7 @@
+; $Id$
+name = Optionwidgets
+description = Defines selection, check box and radio button widgets for text and numeric fields.
+dependencies[] = field
+package = Core - fields
+core = 7.x
+files[]=option_widgets.module
=== added file 'modules/field/modules/option_widgets/option_widgets.module'
--- modules/field/modules/option_widgets/option_widgets.module 1970-01-01 00:00:00 +0000
+++ modules/field/modules/option_widgets/option_widgets.module 2009-01-15 16:50:15 +0000
@@ -0,0 +1,438 @@
+'. t('Create a list of options as a list in Allowed values list or as an array in PHP code. These values will be the same for %field in all field types.', array('%field' => $label)) .'';
+
+ if ($widget_type == 'option_widgets_onoff') {
+ $output .= ''. t("For a 'single on/off checkbox' widget, define the 'off' value first, then the 'on' value in the Allowed values section. Note that the checkbox will be labeled with the label of the 'on' value.") .'
';
+ }
+ elseif ($widget_type == 'option_widgets_buttons') {
+ $output .= ''. t("The 'checkboxes/radio buttons' widget will display checkboxes if the cardinality option is selected for this field, otherwise radios will be displayed.") .'
';
+ }
+
+ if (in_array($field_type, array('text', 'number_integer', 'number_float', 'number_decimal'))
+ && in_array($widget_type, array('option_widgets_onoff', 'option_widgets_buttons', 'option_widgets_select'))) {
+ $form['field']['allowed_values_fieldset']['#collapsed'] = FALSE;
+ $form['field']['allowed_values_fieldset']['#description'] = $output;
+
+ // If no 'allowed values' were set yet, add a remainder in the messages area.
+ if (empty($form_state['post'])
+ && empty($form['field']['allowed_values_fieldset']['allowed_values']['#default_value'])
+ && empty($form['field']['allowed_values_fieldset']['advanced_options']['allowed_values_php']['#default_value'])) {
+ drupal_set_message(t("You need to specify the 'allowed values' for this field."), 'warning');
+ }
+ }
+ }
+}
+
+/**
+ * Implementation of hook_theme().
+ */
+function option_widgets_theme() {
+ return array(
+ 'option_widgets_select' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'option_widgets_buttons' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'option_widgets_onoff' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'option_widgets_none' => array(
+ 'arguments' => array('widget_type' => NULL, 'field_name' => NULL, 'node_type' => NULL),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_widget_info().
+ *
+ * We need custom handling of multiple values because we need
+ * to combine them into a options list rather than display
+ * cardinality elements. We will use the field module's default
+ * handling for default values.
+ *
+ * Callbacks can be omitted if default handing is used.
+ * They're included here just so this module can be used
+ * as an example for custom modules that might do things
+ * differently.
+ */
+function option_widgets_field_widget_info() {
+
+ return array(
+ 'option_widgets_select' => array(
+ 'label' => t('Select list'),
+ 'field types' => array('list', 'list_boolean', 'list_text', 'list_number'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'option_widgets_buttons' => array(
+ 'label' => t('Check boxes/radio buttons'),
+ 'field types' => array('list', 'list_boolean', 'list_text', 'list_number'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'option_widgets_onoff' => array(
+ 'label' => t('Single on/off checkbox'),
+ 'field types' => array('list_boolean'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Implementation of FAPI hook_elements().
+ *
+ * Any FAPI callbacks needed for individual widgets can be declared here,
+ * and the element will be passed to those callbacks for processing.
+ *
+ * Drupal will automatically theme the element using a theme with
+ * the same name as the hook_elements key.
+ */
+function option_widgets_elements() {
+ return array(
+ 'option_widgets_select' => array(
+ '#input' => TRUE,
+ '#columns' => array('value'), '#delta' => 0,
+ '#process' => array('option_widgets_select_process'),
+ ),
+ 'option_widgets_buttons' => array(
+ '#input' => TRUE,
+ '#columns' => array('value'), '#delta' => 0,
+ '#process' => array('option_widgets_buttons_process'),
+ ),
+ 'option_widgets_onoff' => array(
+ '#input' => TRUE,
+ '#columns' => array('value'), '#delta' => 0,
+ '#process' => array('option_widgets_onoff_process'),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_widget().
+ */
+function option_widgets_field_widget(&$form, &$form_state, $instance, $items, $delta = NULL) {
+ $element = array(
+ '#type' => $instance['widget']['type'],
+ '#default_value' => !empty($items) ? $items : array(),
+ );
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function option_widgets_buttons_process($element, $edit, &$form_state, $form) {
+ $field = $form['#fields'][$element['#field_name']]['field'];
+ $instance = $form['#fields'][$element['#field_name']]['instance'];
+ $field_key = $element['#columns'][0];
+
+ // See if this element is in the database format or the transformed format,
+ // and transform it if necessary.
+ if (is_array($element['#value']) && !array_key_exists($field_key, $element['#value'])) {
+ $element['#value'] = option_widgets_data2form($element, $element['#default_value'], $field);
+ }
+ $options = option_widgets_options($field, $instance);
+ $multiple = isset($element['#multiple']) ? $element['#multiple'] : $field['cardinality'] > 1 || $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED;
+ $element[$field_key] = array(
+ '#type' => $multiple ? 'checkboxes' : 'radios',
+ '#title' => $element['#title'],
+ '#description' => $element['#description'],
+ '#required' => isset($element['#required']) ? $element['#required'] : $instance['required'],
+ '#multiple' => $multiple,
+ '#options' => $options,
+ '#default_value' => isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : NULL,
+ );
+
+ // Set #element_validate in a way that it will not wipe out other
+ // validation functions already set by other modules.
+ if (empty($element['#element_validate'])) {
+ $element['#element_validate'] = array();
+ }
+ array_unshift($element['#element_validate'], 'option_widgets_validate');
+
+ // Make sure field info will be available to the validator which
+ // does not get the values in $form.
+ $form_state['#fields'][$element['#field_name']] = $form['#fields'][$element['#field_name']];
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function option_widgets_select_process($element, $edit, &$form_state, $form) {
+ $field = $form['#fields'][$element['#field_name']]['field'];
+ $instance = $form['#fields'][$element['#field_name']]['instance'];
+ $field_key = $element['#columns'][0];
+
+ // See if this element is in the database format or the transformed format,
+ // and transform it if necessary.
+ if (is_array($element['#value']) && !array_key_exists($field_key, $element['#value'])) {
+ $element['#value'] = option_widgets_data2form($element, $element['#default_value'], $field);
+ }
+
+ $options = option_widgets_options($field, $instance);
+ $element[$field_key] = array(
+ '#type' => 'select',
+ '#title' => $element['#title'],
+ '#description' => $element['#description'],
+ '#required' => isset($element['#required']) ? $element['#required'] : $instance['required'],
+ '#multiple' => isset($element['#multiple']) ? $element['#multiple'] : $field['cardinality'],
+ '#options' => $options,
+ '#default_value' => isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : NULL,
+ );
+
+ // Set #element_validate in a way that it will not wipe out other
+ // validation functions already set by other modules.
+ if (empty($element['#element_validate'])) {
+ $element['#element_validate'] = array();
+ }
+ array_unshift($element['#element_validate'], 'option_widgets_validate');
+
+ // Make sure field info will be available to the validator which
+ // does not get the values in $form.
+ $form_state['#fields'][$element['#field_name']] = $form['#fields'][$element['#field_name']];
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ */
+function option_widgets_onoff_process($element, $edit, &$form_state, $form) {
+ $field = $form['#fields'][$element['#field_name']]['field'];
+ $instance = $form['#fields'][$element['#field_name']]['instance'];
+ $field_key = $element['#columns'][0];
+
+ // See if this element is in the database format or the transformed format,
+ // and transform it if necessary.
+ if (is_array($element['#value']) && !array_key_exists($field_key, $element['#value'])) {
+ $element['#value'] = option_widgets_data2form($element, $element['#default_value'], $field);
+ }
+ $options = option_widgets_options($field, $instance);
+ $keys = array_keys($options);
+ $on_value = (!empty($keys) && isset($keys[1])) ? $keys[1] : NULL;
+ $element[$field_key] = array(
+ '#type' => 'checkbox',
+ '#title' => isset($options[$on_value]) ? $options[$on_value] : '',
+ '#description' => $element['#description'],
+ '#default_value' => isset($element['#value'][$field_key][0]) ? $element['#value'][$field_key][0] == $on_value : FALSE,
+ '#return_value' => $on_value,
+ );
+
+ // Set #element_validate in a way that it will not wipe out other
+ // validation functions already set by other modules.
+ if (empty($element['#element_validate'])) {
+ $element['#element_validate'] = array();
+ }
+ array_unshift($element['#element_validate'], 'option_widgets_validate');
+
+ // Make sure field info will be available to the validator which
+ // does not get the values in $form.
+ $form_state['#fields'][$element['#field_name']] = $form['#fields'][$element['#field_name']];
+ return $element;
+}
+
+/**
+ * FAPI function to validate option_widgets element.
+ */
+function option_widgets_validate($element, &$form_state) {
+ // Transpose selections from field => delta to delta => field,
+ // turning cardinality selected options into cardinality parent elements.
+ // Immediate parent is the delta, need to get back to parent's parent
+ // to create cardinality elements.
+ $field = $form_state['#fields'][$element['#field_name']]['field'];
+ $items = option_widgets_form2data($element, $field);
+ form_set_value($element, $items, $form_state);
+
+ // Check we don't exceed the allowed number of values.
+ if ($field['cardinality'] >= 2) {
+ // Filter out 'none' value (if present, will always be in key 0)
+ $field_key = $element['#columns'][0];
+ if (isset($items[0][$field_key]) && $items[0][$field_key] === '') {
+ unset($items[0]);
+ }
+ if (count($items) > $field['cardinality']) {
+ $field_key = $element['#columns'][0];
+ form_error($element[$field_key], t('%name: this field cannot hold more that @count values.', array('%name' => t($field['widget']['label']), '@count' => $field['cardinality'])));
+ }
+ }
+}
+
+/**
+ * Helper function to transpose the values as stored in the database
+ * to the format the widget needs. Can be called anywhere this
+ * transformation is needed.
+ */
+function option_widgets_data2form($element, $items, $field) {
+ $field_key = $element['#columns'][0];
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ $options = option_widgets_options($field, $instance);
+
+ $items_transposed = field_transpose_array_rows_cols($items);
+ $values = (isset($items_transposed[$field_key]) && is_array($items_transposed[$field_key])) ? $items_transposed[$field_key] : array();
+ $keys = array();
+ foreach ($values as $value) {
+ $key = array_search($value, array_keys($options));
+ if (isset($key)) {
+ $keys[] = $value;
+ }
+ }
+ if ($field['cardinality'] || $element['#type'] == 'option_widgets_onoff') {
+ return array($field_key => $keys);
+ }
+ else {
+ return !empty($keys) ? array($field_key => $value) : array();
+ }
+}
+
+/**
+ * Helper function to transpose the values returned by submitting the widget
+ * to the format to be stored in the field. Can be called anywhere this
+ * transformation is needed.
+ */
+function option_widgets_form2data($element, $field) {
+ $field_key = $element['#columns'][0];
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ $items = (array) $element[$field_key]['#value'];
+ $options = option_widgets_options($field, $instance);
+
+ $values = array_values($items);
+
+ if ($element['#type'] == 'option_widgets_onoff' && ($values[0] === 0)) {
+ $keys = array_keys($options);
+ $values = array(array_key_exists(0, $keys) ? $keys[0] : NULL);
+ }
+
+ if (empty($values)) {
+ $values[] = NULL;
+ }
+ $result = field_transpose_array_rows_cols(array($field_key => $values));
+ return $result;
+}
+
+/**
+ * Helper function for finding the allowed values list for a field.
+ *
+ * See if there is a module hook for the option values.
+ * Otherwise, try list_allowed_values() for an options list.
+ */
+function option_widgets_options($field, $instance) {
+ $function = $field['module'] .'_allowed_values';
+ $options = function_exists($function) ? $function($field) : (array) list_allowed_values($field);
+ // Add an empty choice for :
+ // - non required radios
+ // - non required selects
+ if (!$instance['required']) {
+ if ((in_array($instance['widget']['type'], array('option_widgets_buttons', 'node_reference_buttons', 'user_reference_buttons')) && !$field['cardinality'])
+ || (in_array($instance['widget']['type'], array('option_widgets_select', 'node_reference_select', 'user_reference_select')))) {
+ $options = array('' => theme('option_widgets_none', $instance)) + $options;
+ }
+ }
+ return $options;
+}
+
+/**
+ * Theme the label for the empty value for options that are not required.
+ * The default theme will display N/A for a radio list and blank for a select.
+ */
+function theme_option_widgets_none($instance) {
+ switch ($instance['widget']['type']) {
+ case 'option_widgets_buttons':
+ case 'node_reference_buttons':
+ case 'user_reference_buttons':
+ return t('N/A');
+ case 'option_widgets_select':
+ case 'node_reference_select':
+ case 'user_reference_select':
+ return t('- None -');
+ default :
+ return '';
+ }
+}
+
+/**
+ * FAPI themes for option_widgets.
+ *
+ * The select, checkboxes or radios are already rendered by the
+ * select, checkboxes, or radios themes and the HTML output
+ * lives in $element['#children']. Override this theme to
+ * make custom changes to the output.
+ *
+ * $element['#field_name'] contains the field name
+ * $element['#delta] is the position of this element in the group
+ */
+function theme_option_widgets_select($element) {
+ return $element['#children'];
+}
+
+function theme_option_widgets_onoff($element) {
+ return $element['#children'];
+}
+
+function theme_option_widgets_buttons($element) {
+ return $element['#children'];
+}
\ No newline at end of file
=== added directory 'modules/field/modules/text'
=== added file 'modules/field/modules/text/text.info'
--- modules/field/modules/text/text.info 1970-01-01 00:00:00 +0000
+++ modules/field/modules/text/text.info 2009-01-15 16:50:15 +0000
@@ -0,0 +1,8 @@
+; $Id: text.info,v 1.9 2008/04/23 18:02:31 dww Exp $
+name = Text
+description = Defines simple text field types.
+dependencies[] = field
+package = Core - fields
+core = 7.x
+
+files[]=text.module
=== added file 'modules/field/modules/text/text.module'
--- modules/field/modules/text/text.module 1970-01-01 00:00:00 +0000
+++ modules/field/modules/text/text.module 2009-01-15 16:50:16 +0000
@@ -0,0 +1,400 @@
+ array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'text_textfield' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'field_formatter_text_default' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'field_formatter_text_plain' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'field_formatter_text_trimmed' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_info().
+ */
+function text_field_info() {
+ return array(
+ 'text' => array(
+ 'label' => t('Text'),
+ 'description' => t('This field stores varchar text in the database.'),
+ 'settings' => array('max_length' => 255),
+ 'instance_settings' => array('text_processing' => 0),
+ 'default_widget' => 'text_textfield',
+ 'default_formatter' => 'text_default',
+ ),
+ // TODO : not a good name...
+ 'textarea' => array(
+ 'label' => t('Textarea'),
+ 'description' => t('This field stores long text in the database.'),
+ 'instance_settings' => array('text_processing' => 0),
+ 'default_widget' => 'text_textarea',
+ 'default_formatter' => 'text_default',
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_schema().
+ */
+function text_field_columns($field) {
+ if ($field['type'] == 'textarea') {
+ $columns = array(
+ 'value' => array(
+ 'type' => 'text',
+ 'size' => 'big',
+ 'not null' => FALSE,
+ ),
+ );
+ }
+ else {
+ $columns = array(
+ 'value' => array(
+ 'type' => 'varchar',
+ 'length' => $field['settings']['max_length'],
+ 'not null' => FALSE,
+ ),
+ );
+ }
+ $columns += array(
+ 'format' => array(
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'not null' => FALSE,
+ ),
+ );
+ return $columns;
+}
+
+/**
+ * Implementation of hook_field_validate().
+ */
+function text_field_validate($obj_type, $object, $field, $instance, $items, $form) {
+ if (is_array($items)) {
+ foreach ($items as $delta => $item) {
+ $error_element = isset($item['_error_element']) ? $item['_error_element'] : '';
+ if (is_array($item) && isset($item['_error_element'])) unset($item['_error_element']);
+ if (!empty($item['value'])) {
+ if (!empty($field['settings']['max_length']) && drupal_strlen($item['value']) > $field['settings']['max_length']) {
+ form_set_error($error_element, t('%name: the value may not be longer than %max characters.', array('%name' => $instance['label'], '%max' => $field['settings']['max_length'])));
+ }
+ }
+ }
+ }
+}
+
+function text_field_sanitize($obj_type, $object, $field, $instance, &$items) {
+ global $language;
+ foreach ($items as $delta => $item) {
+ // TODO D7 : this code is really node-related.
+ if (!empty($field['text_processing'])) {
+ $check = is_null($object) || (isset($object->build_mode) && $object->build_mode == NODE_BUILD_PREVIEW);
+ $text = isset($item['value']) ? check_markup($item['value'], $item['format'], isset($object->language) ? $object->language : $language, $check) : '';
+ }
+ else {
+ $text = check_plain($item['value']);
+ }
+ $items[$delta]['safe'] = $text;
+ }
+}
+
+/**
+ * Implementation of hook_field_is_empty().
+ */
+function text_field_is_empty($item, $field) {
+ if (empty($item['value']) && (string)$item['value'] !== '0') {
+ return TRUE;
+ }
+ return FALSE;
+}
+
+/**
+ * Implementation of hook_field_formatter_info().
+ */
+function text_field_formatter_info() {
+ return array(
+ 'text_default' => array(
+ 'label' => t('Default'),
+ 'field types' => array('text', 'textarea'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'text_plain' => array(
+ 'label' => t('Plain text'),
+ 'field types' => array('text', 'textarea'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'text_trimmed' => array(
+ 'label' => t('Trimmed'),
+ 'field types' => array('text', 'textarea'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Theme function for 'default' text field formatter.
+ */
+function theme_field_formatter_text_default($element) {
+ return $element['#item']['safe'];
+}
+
+/**
+ * Theme function for 'plain' text field formatter.
+ */
+function theme_field_formatter_text_plain($element) {
+ return strip_tags($element['#item']['safe']);
+}
+
+/**
+ * Theme function for 'trimmed' text field formatter.
+ */
+function theme_field_formatter_text_trimmed($element) {
+ $field = field_info_field($element['#field_name']);
+ $instance = field_info_instance($element['#field_name'], $element['#bundle']);
+ return $field['settings']['text_processing'] ? $element['#item']['format'] : NULL;
+}
+
+/**
+ * Implementation of hook_field_widget_info().
+ *
+ * Here we indicate that the field module will handle
+ * the default value and multiple values for these widgets.
+ *
+ * Callbacks can be omitted if default handing is used.
+ * They're included here just so this module can be used
+ * as an example for custom modules that might do things
+ * differently.
+ */
+function text_field_widget_info() {
+ return array(
+ 'text_textfield' => array(
+ 'label' => t('Text field'),
+ 'field types' => array('text'),
+ 'settings' => array('size' => 60),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'text_textarea' => array(
+ 'label' => t('Text area (multiple rows)'),
+ 'field types' => array('textarea'),
+ 'settings' => array('rows' => 5),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Implementation of FAPI hook_elements().
+ *
+ * Any FAPI callbacks needed for individual widgets can be declared here,
+ * and the element will be passed to those callbacks for processing.
+ *
+ * Drupal will automatically theme the element using a theme with
+ * the same name as the hook_elements key.
+ *
+ * Autocomplete_path is not used by text_field_widget but other
+ * widgets can use it (see nodereference and userreference).
+ */
+function text_elements() {
+ return array(
+ 'text_textfield' => array(
+ '#input' => TRUE,
+ '#columns' => array('value'), '#delta' => 0,
+ '#process' => array('text_textfield_process'),
+ '#autocomplete_path' => FALSE,
+ ),
+ 'text_textarea' => array(
+ '#input' => TRUE,
+ '#columns' => array('value', 'format'), '#delta' => 0,
+ '#process' => array('text_textarea_process'),
+ '#filter_value' => FILTER_FORMAT_DEFAULT,
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_widget().
+ *
+ * Attach a single form element to the form. It will be built out and
+ * validated in the callback(s) listed in hook_elements. We build it
+ * out in the callbacks rather than here in hook_field_widget so it can be
+ * plugged into any module that can provide it with valid
+ * $field information.
+ *
+ * field module will set the weight, field name and delta values
+ * for each form element. This is a change from earlier CCK versions
+ * where the widget managed its own multiple values.
+ *
+ * If there are multiple values for this field, the field module will
+ * call this function as many times as needed.
+ *
+ * @param $form
+ * the entire form array, $form['#node'] holds node information
+ * @param $form_state
+ * the form_state, $form_state['values'][$field['field_name']]
+ * holds the field's form values.
+ * @param $instance
+ * the field instance array
+ * @param $items
+ * array of default values for this field
+ * @param $delta
+ * the order of this item in the array of subelements (0, 1, 2, etc)
+ *
+ * @return
+ * the form item for a single element for this field
+ */
+function text_field_widget(&$form, &$form_state, $instance, $items, $delta = 0) {
+ $element = array(
+ '#type' => $instance['widget']['type'],
+ '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
+ );
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ *
+ * TODO: For widgets to be actual FAPI 'elements', reusable outside of a
+ * 'field' context, they shoudn't rely on $field and $instance. The bits of
+ * information needed to adjust the behavior of the 'element' should be
+ * extracted in hook_field_widget() above.
+ */
+function text_textfield_process($element, $edit, $form_state, $form) {
+ $field = $form['#fields'][$element['#field_name']]['field'];
+ $instance = $form['#fields'][$element['#field_name']]['instance'];
+ $field_key = $element['#columns'][0];
+ $delta = $element['#delta'];
+
+ $element[$field_key] = array(
+ '#type' => 'textfield',
+ '#default_value' => isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : NULL,
+ '#autocomplete_path' => $element['#autocomplete_path'],
+ '#size' => $instance['widget']['settings']['size'],
+ '#attributes' => array('class' => 'text'),
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#description' => $element['#description'],
+ '#required' => $element['#required'],
+ '#field_name' => $element['#field_name'],
+ '#bundle' => $element['#bundle'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+
+ $element[$field_key]['#maxlength'] = !empty($field['settings']['max_length']) ? $field['settings']['max_length'] : NULL;
+
+ if (!empty($instance['settings']['text_processing'])) {
+ $filter_key = $element['#columns'][1];
+ $format = isset($element['#value'][$filter_key]) ? $element['#value'][$filter_key] : FILTER_FORMAT_DEFAULT;
+ $parents = array_merge($element['#parents'] , array($filter_key));
+ $element[$filter_key] = filter_form($format, 1, $parents);
+ }
+
+ // Used so that hook_field('validate') knows where to flag an error.
+ // TODO: rework that. See http://groups.drupal.org/node/18019.
+ $element['_error_element'] = array(
+ '#type' => 'value',
+ '#value' => implode('][', array_merge($element['#parents'], array($field_key))),
+ );
+
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function text_textarea_process($element, $edit, $form_state, $form) {
+ $field = $form['#fields'][$element['#field_name']]['field'];
+ $instance = $form['#fields'][$element['#field_name']]['instance'];
+ $field_key = $element['#columns'][0];
+ $delta = $element['#delta'];
+ $element[$field_key] = array(
+ '#type' => 'textarea',
+ '#default_value' => isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : NULL,
+ '#rows' => $instance['widget']['settings']['rows'],
+ '#weight' => 0,
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#description' => $element['#description'],
+ '#required' => $element['#required'],
+ '#field_name' => $element['#field_name'],
+ '#bundle' => $element['#bundle'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+
+ if (!empty($field['settings']['text_processing'])) {
+ $filter_key = (count($element['#columns']) == 2) ? $element['#columns'][1] : 'format';
+ $format = isset($element['#value'][$filter_key]) ? $element['#value'][$filter_key] : FILTER_FORMAT_DEFAULT;
+ $parents = array_merge($element['#parents'] , array($filter_key));
+ $element[$filter_key] = filter_form($format, 1, $parents);
+ }
+
+ // Used so that hook_field('validate') knows where to flag an error.
+ $element['_error_element'] = array(
+ '#type' => 'value',
+ '#value' => implode('][', array_merge($element['#parents'], array($field_key))),
+ );
+ return $element;
+}
+
+/**
+ * FAPI theme for an individual text elements.
+ *
+ * The textfield or textarea is already rendered by the
+ * textfield or textarea themes and the html output
+ * lives in $element['#children']. Override this theme to
+ * make custom changes to the output.
+ *
+ * $element['#field_name'] contains the field name
+ * $element['#delta] is the position of this element in the group
+ */
+function theme_text_textfield($element) {
+ return $element['#children'];
+}
+
+function theme_text_textarea($element) {
+ return $element['#children'];
+}
\ No newline at end of file
=== added file 'modules/field/modules/text/text.test'
--- modules/field/modules/text/text.test 1970-01-01 00:00:00 +0000
+++ modules/field/modules/text/text.test 2009-01-15 16:50:16 +0000
@@ -0,0 +1,39 @@
+ t('Text Field'),
+ 'description' => t("Test the creation of text fields."),
+ 'group' => t('Field')
+ );
+ }
+
+ function setUp() {
+ parent::setUp('field', 'text', 'field_test');
+ }
+
+ // Test widgets.
+
+ /**
+ * Test textfield widget.
+ */
+ function testTextfieldWidget() {
+ // Create a field
+ $field = $this->drupalCreateField('text');
+ $this->instance = $this->drupalCreateFieldInstance($field['field_name'], 'text_textfield', 'text_default', FIELD_TEST_BUNDLE);
+
+ }
+
+ /**
+ * Test textarea widget.
+ */
+
+ // Test formatters.
+ /**
+ *
+ */
+}
=== added directory 'modules/field/modules/user_reference'
=== added file 'modules/field/modules/user_reference/user_reference.info'
--- modules/field/modules/user_reference/user_reference.info 1970-01-01 00:00:00 +0000
+++ modules/field/modules/user_reference/user_reference.info 2009-01-15 16:50:16 +0000
@@ -0,0 +1,9 @@
+; $Id$
+name = User Reference
+description = Defines a field type for referencing a user from a node.
+dependencies[] = field
+dependencies[] = text
+dependencies[] = option_widgets
+package = Core - fields
+core = 7.x
+files[]=user_reference.module
\ No newline at end of file
=== added file 'modules/field/modules/user_reference/user_reference.module'
--- modules/field/modules/user_reference/user_reference.module 1970-01-01 00:00:00 +0000
+++ modules/field/modules/user_reference/user_reference.module 2009-01-15 16:50:15 +0000
@@ -0,0 +1,761 @@
+ 'user_reference autocomplete',
+ 'page callback' => 'user_reference_autocomplete',
+ 'access arguments' => array('access content'),
+ 'type' => MENU_CALLBACK
+ );
+ return $items;
+}
+
+/**
+ * Implementation of hook_theme().
+ */
+function user_reference_theme() {
+ return array(
+ 'user_reference_select' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'user_reference_buttons' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'user_reference_autocomplete' => array(
+ 'arguments' => array('element' => NULL),
+ ),
+ 'field_formatter_formatter_user_reference_default' => array(
+ 'arguments' => array('element'),
+ ),
+ 'field_formatter_formatter_user_reference_plain' => array(
+ 'arguments' => array('element'),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_info().
+ */
+function user_reference_field_info() {
+ return array(
+ 'user_reference' => array(
+ 'label' => t('User reference'),
+ 'description' => t('This field stores the ID of a related user as an integer value.'),
+ 'settings' => array('referenceable_roles', 'referenceable_status'),
+ 'default_widget' => 'user_reference_autocomplete',
+ 'default_formatter' => 'user_reference_default',
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_settings().
+ */
+function user_reference_field_settings($op, $field) {
+ switch ($op) {
+ case 'form':
+ $form = array();
+ $form['referenceable_roles'] = array(
+ '#type' => 'checkboxes',
+ '#title' => t('User roles that can be referenced'),
+ '#default_value' => isset($field['referenceable_roles']) && is_array($field['referenceable_roles']) ? array_filter($field['referenceable_roles']) : array(),
+ '#options' => user_roles(1),
+ );
+ $form['referenceable_status'] = array(
+ '#type' => 'checkboxes',
+ '#title' => t('User status that can be referenced'),
+ '#default_value' => isset($field['referenceable_status']) && is_array($field['referenceable_status']) ? array_filter($field['referenceable_status']) : array(1),
+ '#options' => array(1 => t('Active'), 0 => t('Blocked')),
+ );
+ return $form;
+
+ case 'database columns':
+ $columns = array(
+ 'uid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE),
+ );
+ return $columns;
+
+ }
+}
+
+/**
+ * Implementation of hook_field().
+ */
+function user_reference_field($op, $node, $field, &$items, $teaser, $page) {
+ switch ($op) {
+ case 'validate':
+ // Extract uids to check.
+ $ids = array();
+ foreach ($items as $delta => $item) {
+ if (is_array($item) && !empty($item['uid']) && is_numeric($item['uid'])) {
+ $ids[] = $item['uid'];
+ }
+ }
+ $refs = _user_reference_potential_references($field, '', NULL, $ids);
+ foreach ($items as $delta => $item) {
+ if (is_array($item)) {
+ $error_element = isset($item['_error_element']) ? $item['_error_element'] : '';
+ if (is_array($item) && isset($item['_error_element'])) unset($item['_error_element']);
+ if (!empty($item['uid']) && !isset($refs[$item['uid']])) {
+ form_set_error($error_element, t('%name: invalid user.', array('%name' => t($field['widget']['label']))));
+ }
+ }
+ }
+ return $items;
+ }
+}
+
+/**
+ * Implementation of hook_field_is_empty().
+ */
+function user_reference_field_is_empty($item, $field) {
+ if (empty($item['uid'])) {
+ return TRUE;
+ }
+ return FALSE;
+}
+
+/**
+ * Implementation of hook_field_formatter_info().
+ */
+function user_reference_field_formatter_info() {
+ return array(
+ 'user_reference_default' => array(
+ 'label' => t('Default'),
+ 'field types' => array('user_reference'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'user_reference_plain' => array(
+ 'label' => t('Plain text'),
+ 'field types' => array('user_reference'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Theme function for 'default' user_reference field formatter.
+ */
+function theme_field_formatter_formatter_user_reference_default($element) {
+ $output = '';
+
+ if (isset($element['#item']['uid']) && $account = user_load(array('uid' => $element['#item']['uid']))) {
+ $output = theme('username', $account);
+ }
+ return $output;
+}
+
+/**
+ * Theme function for 'plain' user_reference field formatter.
+ */
+function theme_field_formatter_formatter_user_reference_plain($element) {
+ $output = '';
+ if (isset($element['#item']['uid']) && $account = user_load(array('uid' => $element['#item']['uid']))) {
+ $output = $account->name;
+ }
+ return $output;
+}
+
+/**
+ * Implementation of hook_field_widget_info().
+ *
+ * We need custom handling of multiple values for the user_reference_select
+ * widget because we need to combine them into a options list rather
+ * than display multiple elements.
+ *
+ * We will use the field module's default handling for default value.
+ *
+ * Callbacks can be omitted if default handing is used.
+ * They're included here just so this module can be used
+ * as an example for custom modules that might do things
+ * differently.
+ */
+function user_reference_field_widget_info() {
+ return array(
+ 'user_reference_select' => array(
+ 'label' => t('Select list'),
+ 'field types' => array('user_reference'),
+ 'settings' => array('autocomplete_match', 'reverse_link'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'user_reference_buttons' => array(
+ 'label' => t('Check boxes/radio buttons'),
+ 'field types' => array('user_reference'),
+ 'settings' => array('autocomplete_match', 'reverse_link'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_CUSTOM,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ 'user_reference_autocomplete' => array(
+ 'label' => t('Autocomplete text field'),
+ 'field types' => array('user_reference'),
+ 'settings' => array('autocomplete_match', 'reverse_link'),
+ 'behaviors' => array(
+ 'multiple values' => FIELD_BEHAVIOR_DEFAULT,
+ 'default value' => FIELD_BEHAVIOR_DEFAULT,
+ ),
+ ),
+ );
+}
+
+/**
+ * Implementation of FAPI hook_elements().
+ *
+ * Any FAPI callbacks needed for individual widgets can be declared here,
+ * and the element will be passed to those callbacks for processing.
+ *
+ * Drupal will automatically theme the element using a theme with
+ * the same name as the hook_elements key.
+ *
+ * Autocomplete_path is not used by text_widget but other widgets can use it
+ * (see nodereference and user_reference).
+ */
+function user_reference_elements() {
+ return array(
+ 'user_reference_select' => array(
+ '#input' => TRUE,
+ '#columns' => array('uid'), '#delta' => 0,
+ '#process' => array('user_reference_select_process'),
+ ),
+ 'user_reference_buttons' => array(
+ '#input' => TRUE,
+ '#columns' => array('uid'), '#delta' => 0,
+ '#process' => array('user_reference_buttons_process'),
+ ),
+ 'user_reference_autocomplete' => array(
+ '#input' => TRUE,
+ '#columns' => array('name'), '#delta' => 0,
+ '#process' => array('user_reference_autocomplete_process'),
+ '#autocomplete_path' => FALSE,
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_field_widget_settings().
+ */
+function user_reference_field_widget_settings($op, $widget) {
+ switch ($op) {
+ case 'form':
+ $form = array();
+ $match = isset($widget['autocomplete_match']) ? $widget['autocomplete_match'] : 'contains';
+ if ($widget['type'] == 'user_reference_autocomplete') {
+ $form['autocomplete_match'] = array(
+ '#type' => 'select',
+ '#title' => t('Autocomplete matching'),
+ '#default_value' => $match,
+ '#options' => array(
+ 'starts_with' => t('Starts with'),
+ 'contains' => t('Contains'),
+ ),
+ '#description' => t('Select the method used to collect autocomplete suggestions. Note that Contains can cause performance issues on sites with thousands of users.'),
+ );
+ }
+ else {
+ $form['autocomplete_match'] = array('#type' => 'hidden', '#value' => $match);
+ }
+ $form['reverse_link'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Reverse link'),
+ '#default_value' => isset($widget['reverse_link']) ? $widget['reverse_link'] : 0,
+ '#description' => t('If selected, a reverse link back to the referencing node will displayed on the referenced user record.'),
+ );
+ return $form;
+ }
+}
+
+/**
+ * Implementation of hook_field_widget().
+ *
+ * Attach a single form element to the form. It will be built out and
+ * validated in the callback(s) listed in hook_elements. We build it
+ * out in the callbacks rather than here in hook_widget so it can be
+ * plugged into any module that can provide it with valid
+ * $field information.
+ *
+ * Field module will set the weight, field name and delta values
+ * for each form element. This is a change from earlier CCK versions
+ * where the widget managed its own multiple values.
+ *
+ * If there are multiple values for this field, the field module will
+ * call this function as many times as needed.
+ *
+ * @param $form
+ * the entire form array, $form['#node'] holds node information
+ * @param $form_state
+ * the form_state, $form_state['values'][$field['field_name']]
+ * holds the field's form values.
+ * @param $instance
+ * the field instance array
+ * @param $items
+ * array of default values for this field
+ * @param $delta
+ * the order of this item in the array of subelements (0, 1, 2, etc)
+ *
+ * @return
+ * the form item for a single element for this field
+ */
+function user_reference_field_widget(&$form, &$form_state, $instance, $items, $delta = 0) {
+ switch ($instance['widget']['type']) {
+ case 'user_reference_select':
+ $element = array(
+ '#type' => 'user_reference_select',
+ '#default_value' => $items,
+ );
+ break;
+
+ case 'user_reference_buttons':
+ $element = array(
+ '#type' => 'user_reference_buttons',
+ '#default_value' => $items,
+ );
+ break;
+
+ case 'user_reference_autocomplete':
+ $element = array(
+ '#type' => 'user_reference_autocomplete',
+ '#default_value' => isset($items[$delta]) ? $items[$delta] : NULL,
+ '#value_callback' => 'user_reference_autocomplete_value',
+ );
+ break;
+ }
+ return $element;
+}
+
+/**
+ * Value for a user_reference autocomplete element.
+ *
+ * Substitute in the user name for the uid.
+ */
+function user_reference_autocomplete_value($element, $edit = FALSE) {
+ $field_key = $element['#columns'][0];
+ if (!empty($element['#default_value'][$field_key])) {
+ $value = db_result(db_query("SELECT name FROM {users} WHERE uid = '%d'", $element['#default_value'][$field_key]));
+ return array($field_key => $value);
+ }
+ return array($field_key => NULL);
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function user_reference_select_process($element, $edit, $form_state, $form) {
+ // The user_reference_select widget doesn't need to create its own
+ // element, it can wrap around the optionwidgets_select element.
+ // Add a validation step where the value can be unwrapped.
+ $field_key = $element['#columns'][0];
+ $element[$field_key] = array(
+ '#type' => 'optionwidgets_select',
+ '#default_value' => isset($element['#value']) ? $element['#value'] : '',
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#required' => $element['#required'],
+ '#description' => $element['#description'],
+ '#field_name' => $element['#field_name'],
+ '#type_name' => $element['#type_name'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+ if (empty($element[$field_key]['#element_validate'])) {
+ $element[$field_key]['#element_validate'] = array();
+ }
+ array_unshift($element[$field_key]['#element_validate'], 'user_reference_optionwidgets_validate');
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function user_reference_buttons_process($element, $edit, $form_state, $form) {
+ // The user_reference_select widget doesn't need to create its own
+ // element, it can wrap around the optionwidgets_select element.
+ // Add a validation step where the value can be unwrapped.
+ $field_key = $element['#columns'][0];
+ $element[$field_key] = array(
+ '#type' => 'optionwidgets_buttons',
+ '#default_value' => isset($element['#value']) ? $element['#value'] : '',
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#required' => $element['#required'],
+ '#description' => $element['#description'],
+ '#field_name' => $element['#field_name'],
+ '#type_name' => $element['#type_name'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+ if (empty($element[$field_key]['#element_validate'])) {
+ $element[$field_key]['#element_validate'] = array();
+ }
+ array_unshift($element[$field_key]['#element_validate'], 'user_reference_optionwidgets_validate');
+ return $element;
+}
+
+/**
+ * Process an individual element.
+ *
+ * Build the form element. When creating a form using FAPI #process,
+ * note that $element['#value'] is already set.
+ *
+ * The $field and $instance arrays are in $form['#fields'][$element['#field_name']].
+ */
+function user_reference_autocomplete_process($element, $edit, $form_state, $form) {
+ // The user_reference autocomplete widget doesn't need to create its own
+ // element, it can wrap around the text_textfield element and add an autocomplete
+ // path and some extra processing to it.
+ // Add a validation step where the value can be unwrapped.
+ $field_key = $element['#columns'][0];
+
+ $element[$field_key] = array(
+ '#type' => 'text_textfield',
+ '#default_value' => isset($element['#value']) ? $element['#value'] : '',
+ '#autocomplete_path' => 'user_reference/autocomplete/'. $element['#field_name'],
+ // The following values were set by the field module and need
+ // to be passed down to the nested element.
+ '#title' => $element['#title'],
+ '#required' => $element['#required'],
+ '#description' => $element['#description'],
+ '#field_name' => $element['#field_name'],
+ '#type_name' => $element['#type_name'],
+ '#delta' => $element['#delta'],
+ '#columns' => $element['#columns'],
+ );
+ if (empty($element[$field_key]['#element_validate'])) {
+ $element[$field_key]['#element_validate'] = array();
+ }
+ array_unshift($element[$field_key]['#element_validate'], 'user_reference_autocomplete_validate');
+
+ // Used so that hook_field('validate') knows where to flag an error.
+ $element['_error_element'] = array(
+ '#type' => 'value',
+ // Wrapping the element around a text_textfield element creates a
+ // nested element, so the final id will look like 'field-name-0-uid-uid'.
+ '#value' => implode('][', array_merge($element['#parents'], array($field_key, $field_key))),
+ );
+ return $element;
+}
+
+/**
+ * Validate a select/buttons element.
+ *
+ * Remove the wrapper layer and set the right element's value.
+ * We don't know exactly where this element is, so we drill down
+ * through the element until we get to our key.
+ *
+ * We use $form_state['values'] instead of $element['#value']
+ * to be sure we have the most accurate value when other modules
+ * like optionwidgets are using #element_validate to alter the value.
+ */
+function user_reference_optionwidgets_validate($element, &$form_state) {
+ $field_key = $element['#columns'][0];
+
+ $value = $form_state['values'];
+ $new_parents = array();
+ foreach ($element['#parents'] as $parent) {
+ $value = $value[$parent];
+ // Use === to be sure we get right results if parent is a zero (delta) value.
+ if ($parent === $field_key) {
+ $element['#parents'] = $new_parents;
+ form_set_value($element, $value, $form_state);
+ break;
+ }
+ $new_parents[] = $parent;
+ }
+}
+
+/**
+ * Validate an autocomplete element.
+ *
+ * Remove the wrapper layer and set the right element's value.
+ * This will move the nested value at 'field-name-0-uid-uid'
+ * back to its original location, 'field-name-0-uid'.
+ */
+function user_reference_autocomplete_validate($element, &$form_state) {
+ $field_name = $element['#field_name'];
+ $type_name = $element['#type_name'];
+ $field = field_fields($field_name, $type_name);
+ $field_key = $element['#columns'][0];
+ $value = $element['#value'][$field_key];
+ $uid = NULL;
+ if (!empty($value)) {
+ $reference = _user_reference_potential_references($field, $value, 'equals', NULL, 1);
+ if (empty($reference)) {
+ form_error($element[$field_key], t('%name: found no valid user with that name.', array('%name' => t($field['widget']['label']))));
+ }
+ else {
+ $uid = key($reference);
+ }
+ }
+ form_set_value($element, $uid, $form_state);
+}
+
+/**
+ * Implementation of hook_allowed_values().
+ */
+function user_reference_allowed_values($field) {
+ $references = _user_reference_potential_references($field);
+
+ $options = array();
+ foreach ($references as $key => $value) {
+ // Views theming runs check_plain (htmlentities) on the values.
+ // We reverse that with html_entity_decode.
+ $options[$key] = html_entity_decode(strip_tags($value['rendered']), ENT_QUOTES);
+ }
+ return $options;
+}
+
+/**
+ * Fetch an array of all candidate referenced users.
+ *
+ * This info is used in various places (aloowed values, autocomplete results,
+ * input validation...). Some of them only need the uids, others nid + names,
+ * others yet uid + names + rendered row (for display in widgets).
+ * The array we return contains all the potentially needed information, and lets
+ * consumers use the parts they actually need.
+ *
+ * @param $field
+ * The field description.
+ * @param $string
+ * Optional string to filter usernames on (used by autocomplete)
+ * @param $match
+ * Operator to match filtered name against, can be any of:
+ * 'contains', 'equals', 'starts_with'
+ * @param $ids
+ * Optional user ids to lookup (the $string and $match arguments will be
+ * ignored).
+ * @param $limit
+ * If non-zero, limit the size of the result set.
+ *
+ * @return
+ * An array of valid users in the form:
+ * array(
+ * uid => array(
+ * 'title' => The user name,
+ * 'rendered' => The text to display in widgets (can be HTML)
+ * ),
+ * ...
+ * )
+ */
+function _user_reference_potential_references($field, $string = '', $match = 'contains', $ids = array(), $limit = NULL) {
+ static $results = array();
+
+ // Create unique id for static cache.
+ $cid = $field['field_name'] .':'. $match .':'. ($string !== '' ? $string : implode('-', $ids)) .':'. $limit;
+ if (!isset($results[$cid])) {
+ $references = FALSE;
+ if ($references === FALSE) {
+ $references = _user_reference_potential_references_standard($field, $string, $match, $ids, $limit);
+ }
+
+ // Store the results.
+ $results[$cid] = $references;
+ }
+
+ return $results[$cid];
+}
+
+/**
+ * Helper function for _user_reference_potential_references():
+ * referenceable users defined by user role and status
+ */
+function _user_reference_potential_references_standard($field, $string = '', $match = 'contains', $ids = array(), $limit = NULL) {
+ $where = array();
+ $args = array();
+ $join = array();
+
+ if ($string !== '') {
+ $match_operators = array(
+ 'contains' => "LIKE '%%%s%%'",
+ 'equals' => "= '%s'",
+ 'starts_with' => "LIKE '%s%%'",
+ );
+ $where[] = 'u.name '. (isset($match_operators[$match]) ? $match_operators[$match] : $match_operators['contains']);
+ $args[] = $string;
+ }
+ elseif ($ids) {
+ $where[] = 'u.uid IN (' . db_placeholders($ids) . ')';
+ $args = array_merge($args, $ids);
+ }
+ else {
+ $where[] = "u.uid > 0";
+ }
+
+ $roles = array();
+ if (isset($field['referenceable_roles']) && is_array($field['referenceable_roles'])) {
+ // keep only selected checkboxes
+ $roles = array_filter($field['referenceable_roles']);
+ // filter invalid values that seems to get through sometimes ??
+ $roles = array_intersect(array_keys(user_roles(1)), $roles);
+ }
+ if (!empty($roles) && !in_array(DRUPAL_AUTHENTICATED_RID, $roles)) {
+ $where[] = "r.rid IN (". implode($roles, ',') .")";
+ $join[] = 'LEFT JOIN {users_roles} r ON u.uid = r.uid';
+ }
+
+ $status = array();
+ if (isset($field['referenceable_status']) && is_array($field['referenceable_status'])) {
+ // keep only selected checkboxes
+ $status = array_filter($field['referenceable_status']);
+ }
+ if (!empty($status)) {
+ // Limit query if only one status should be referenced.
+ if (count($status) == 1) {
+ $where[] = "u.status = ". array_pop($status);
+ }
+ }
+
+ $users = array();
+ $where_clause = $where ? 'WHERE ('. implode(') AND (', $where) .')' : '';
+ $result = db_query('SELECT u.name, u.uid FROM {users} u '. implode(' ', $join) ." $where_clause ORDER BY u.name ASC", $args);
+ while ($user = db_fetch_object($result)) {
+ $users[$user->uid] = array(
+ 'title' => $user->name,
+ 'rendered' => $user->name,
+ );
+ }
+ return $users;
+}
+
+/**
+ * Menu callback; Retrieve a pipe delimited string of autocomplete suggestions for existing users
+ */
+function user_reference_autocomplete($field_name, $string = '') {
+ $fields = field_info_fields();
+ $field = $fields[$field_name];
+ $match = isset($field['widget']['autocomplete_match']) ? $field['widget']['autocomplete_match'] : 'contains';
+ $matches = array();
+
+ $references = _user_reference_potential_references($field, $string, $match, array(), 10);
+ foreach ($references as $id => $row) {
+ // Add a class wrapper for a few required CSS overrides.
+ $matches[$row['title']] = ''. $row['rendered'] . '
';
+ }
+ drupal_json($matches);
+}
+
+/**
+ * Implementation of hook_user().
+ */
+function user_reference_user($type, &$edit, &$account) {
+ switch ($type) {
+ case 'load':
+ // Only add links if we are on the user 'view' page.
+ if (arg(0) != 'user' || arg(2)) {
+ return;
+ }
+ // find CCK user_reference field tables
+ // search through them for matching user ids and load those nodes
+ $additions = array();
+ $types = content_types();
+
+ // Find the table and columns to search through, if the same
+ // table comes up in more than one field type, we only need
+ // to search it once.
+ $search_tables = array();
+ $search_links = array();
+ foreach ($types as $type_name => $type) {
+ foreach ($type['fields'] as $field) {
+ // Only add tables when reverse link has been selected.
+ if ($field['type'] == 'user_reference' && !empty($field['widget']['reverse_link'])) {
+ $db_info = content_database_info($field);
+ $search_tables[$db_info['table']] = $db_info['columns']['uid']['column'];
+ $search_links[$db_info['table']] = $field['widget']['reverse_link'];
+ }
+ }
+ }
+ foreach ($search_tables as $table => $column) {
+ $ids = db_query(db_rewrite_sql("SELECT DISTINCT(n.nid) FROM {node} n LEFT JOIN {". $table ."} f ON n.vid = f.vid WHERE f.". $column ."=". $account->uid. " AND n.status = 1"));
+ while ($data = db_fetch_object($ids)) {
+ // TODO, do we really want a complete node_load() here? We only need the title to create a link.
+ $node = node_load($data->nid);
+ $node->reverse_link = $search_links[$table];
+ $additions[$node->type][] = $node;
+ }
+ }
+ $account->user_reference = $additions;
+ return;
+ break;
+
+ case 'view':
+ if (!empty($account->user_reference)) {
+ $node_types = content_types();
+ $additions = array();
+ $values = array();
+ foreach ($account->user_reference as $node_type => $nodes) {
+ foreach ($nodes as $node) {
+ if ($node->reverse_link) {
+ $values[$node_type][] = l($node->title, 'node/'. $node->nid);
+ }
+ }
+ if (isset($values[$node_type])) {
+ $additions[] = array(
+ '#type' => 'user_profile_item',
+ '#title' => check_plain($node_types[$node_type]['name']),
+ '#value' => theme('item_list', $values[$node_type]),
+ );
+ }
+ }
+ if ($additions) {
+ $account->content['user_reference'] = $additions + array(
+ '#type' => 'user_profile_category',
+ '#attributes' => array('class' => 'user-member'),
+ '#title' => t('Related content'),
+ '#weight' => 10,
+ );
+ }
+ }
+ break;
+ }
+}
+
+/**
+ * FAPI theme for an individual elements.
+ *
+ * The textfield or select is already rendered by the
+ * textfield or select themes and the html output
+ * lives in $element['#children']. Override this theme to
+ * make custom changes to the output.
+ *
+ * $element['#field_name'] contains the field name
+ * $element['#delta] is the position of this element in the group
+ */
+function theme_user_reference_select($element) {
+ return $element['#children'];
+}
+
+function theme_user_reference_buttons($element) {
+ return $element['#children'];
+}
+
+function theme_user_reference_autocomplete($element) {
+ return $element['#children'];
+}
\ No newline at end of file
=== added file 'modules/field/sample_code.php'
--- modules/field/sample_code.php 1970-01-01 00:00:00 +0000
+++ modules/field/sample_code.php 2009-01-15 16:50:16 +0000
@@ -0,0 +1,103 @@
+ 'field_single',
+ 'type' => 'text',
+);
+field_create_field($field);
+
+$instance = array(
+ 'field_name' => 'field_single',
+ 'bundle' => 'article',
+ 'label' => 'Single',
+ 'widget' => array(
+ 'type' => 'text_textfield',
+ ),
+ 'display' => array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'text_default',
+ 'exclude' => 0,
+ ),
+ ),
+);
+field_create_instance($instance);
+
+$instance['bundle'] = 'user';
+field_create_instance($instance);
+
+
+$field = array(
+ 'field_name' => 'field_multiple',
+ 'cardinality' => FIELD_CARDINALITY_UNLIMITED,
+ 'type' => 'text',
+);
+field_create_field($field);
+
+$instance = array(
+ 'field_name' => 'field_multiple',
+ 'bundle' => 'article',
+ 'label' => 'Multiple',
+ 'widget' => array(
+ 'type' => 'text_textfield',
+ ),
+ 'display' => array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'text_default',
+ 'exclude' => 0,
+ ),
+ ),
+);
+field_create_instance($instance);
+
+$instance['bundle'] = 'user';
+field_create_instance($instance);
+
+
+// Number
+$field = array(
+ 'field_name' => 'field_integer',
+ 'type' => 'number_integer',
+);
+field_create_field($field);
+$instance = array(
+ 'field_name' => 'field_integer',
+ 'bundle' => 'article',
+ 'label' => 'Integer',
+ 'widget' => array(
+ 'type' => 'number',
+ ),
+ 'display' => array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'number_integer',
+ 'exclude' => 0,
+ ),
+ ),
+);
+field_create_instance($instance);
+
+$field = array(
+ 'field_name' => 'field_decimal',
+ 'type' => 'number_decimal',
+);
+field_create_field($field);
+$instance = array(
+ 'field_name' => 'field_decimal',
+ 'bundle' => 'article',
+ 'label' => 'Decimal',
+ 'widget' => array(
+ 'type' => 'number',
+ ),
+ 'display' => array(
+ 'full' => array(
+ 'label' => 'above',
+ 'type' => 'number_decimal',
+ 'exclude' => 0,
+ ),
+ ),
+);
+field_create_instance($instance);
+
+
=== added directory 'modules/field/theme'
=== added file 'modules/field/theme/field.css'
--- modules/field/theme/field.css 1970-01-01 00:00:00 +0000
+++ modules/field/theme/field.css 2009-01-15 16:50:16 +0000
@@ -0,0 +1,30 @@
+/* Node display */
+.field .field-label,
+.field .field-label-inline,
+.field .field-label-inline-first {
+ font-weight:bold;
+}
+.field .field-label-inline,
+.field .field-label-inline-first {
+ display:inline;
+}
+.field .field-label-inline {
+ visibility:hidden;
+}
+
+.node-form .field-multiple-table td.field-multiple-drag {
+ width:30px;
+ padding-right:0;
+}
+.node-form .field-multiple-table td.field-multiple-drag a.tabledrag-handle{
+ padding-right:.5em;
+}
+
+.node-form .field-add-more .form-submit{
+ margin:0;
+}
+
+.node-form .number {
+ display:inline;
+ width:auto;
+}
\ No newline at end of file
=== added file 'modules/field/theme/field.tpl.php'
--- modules/field/theme/field.tpl.php 1970-01-01 00:00:00 +0000
+++ modules/field/theme/field.tpl.php 2009-01-15 16:50:16 +0000
@@ -0,0 +1,49 @@
+
+
+
+
+
:
+
+
+ $item) :
+ if (!$item['empty']) : ?>
+
+
+
+
'. t('If the Utility module was installed for this purpose, it can be safely disabled and uninstalled.') .'';
+ }
+ $form['tweaks']['admin_menu_tweak_tabs'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Move local tasks into menu'),
+ '#default_value' => variable_get('admin_menu_tweak_tabs', 0),
+ '#description' => t('If enabled, the tabs on the current page are moved into the administration menu. This feature is only available in themes that use the CSS classes tabs primary and tabs secondary for tabs.'),
+ );
+ $form = system_settings_form($form);
+ $form['wipe description'] = array(
+ '#type' => 'item',
+ '#value' => t('If the administration menu displays duplicate menu items, you may need to rebuild your menu items using the Wipe and rebuild button.'),
+ );
+ $form['wipe'] = array(
+ '#type' => 'submit',
+ '#value' => t('Wipe and rebuild'),
+ '#submit' => array('admin_menu_flush_caches'),
+ );
+
+ return $form;
+}
+
+/**
+ * Implementation of hook_flush_caches().
+ *
+ * Wipe the menu so it can be rebuilt from scratch.
+ */
+function admin_menu_flush_caches() {
+ db_delete('menu_links')->condition('menu_name', 'admin_menu')->execute();
+ menu_cache_clear('admin_menu');
+ variable_set('admin_menu_rebuild_links', TRUE);
+}
+
+/**
+ * Helper function for admin_menu_form_devel_admin_settings_alter().
+ *
+ * Extends Devel module with Administration Menu developer settings.
+ */
+function _admin_menu_devel_settings_form_alter(&$form, $form_state) {
+ // Shift system_settings_form buttons.
+ $weight = isset($form['buttons']['#weight']) ? $form['buttons']['#weight'] : 0;
+ $form['buttons']['#weight'] = $weight + 1;
+
+ $form['admin_menu'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Administration menu settings'),
+ '#collapsible' => TRUE,
+ '#collapsed' => TRUE,
+ );
+ $display_options = array('mid', 'weight', 'pid');
+ $display_options = array(0 => t('None'), 'mlid' => t('Menu link ID'), 'weight' => t('Weight'), 'plid' => t('Parent link ID'));
+ $form['admin_menu']['admin_menu_display'] = array(
+ '#type' => 'radios',
+ '#title' => t('Display additional data for each menu item'),
+ '#default_value' => variable_get('admin_menu_display', 0),
+ '#options' => $display_options,
+ '#description' => t('Display the selected items next to each menu item link.'),
+ );
+ $form['admin_menu']['admin_menu_show_all'] = array(
+ '#type' => 'checkbox',
+ '#title' => t('Display all menu items'),
+ '#default_value' => variable_get('admin_menu_show_all', 0),
+ '#description' => t('If enabled, all menu items are displayed regardless of your site permissions. Note: Do not enable on a production site.'),
+ );
+}
+
+/**
+ * Menu callback to enable/disable developer modules.
+ *
+ * This saves up to 150ms on each uncached page request. Not much, but
+ * on larger Drupal sites this is actually a 10% performance increase.
+ */
+function admin_menu_toggle_modules() {
+ $rebuild = FALSE;
+ $saved_state = variable_get('admin_menu_devel_modules_enabled', NULL);
+ if (isset($saved_state)) {
+ // Re-enable modules that were enabled before.
+ module_enable($saved_state);
+ variable_del('admin_menu_devel_modules_enabled');
+ drupal_set_message(t('Enabled these modules: !module-list.', array('!module-list' => implode(', ', $saved_state))));
+ $rebuild = TRUE;
+ }
+ else {
+ // Allow site admins to override this variable via settings.php.
+ $devel_modules = variable_get('admin_menu_devel_modules', array('cache_disable', 'coder', 'content_copy', 'debug', 'delete_all', 'demo', 'devel', 'devel_node_access', 'devel_themer', 'macro', 'form_controller', 'imagecache_ui', 'journal', 'trace', 'upgrade_status', 'user_display_ui', 'util', 'views_ui', 'views_theme_wizard'));
+ // Store currently enabled modules in a variable.
+ $devel_modules = array_intersect(module_list(FALSE, FALSE), $devel_modules);
+ if (!empty($devel_modules)) {
+ variable_set('admin_menu_devel_modules_enabled', $devel_modules);
+ // Disable developer modules.
+ module_disable($devel_modules);
+ drupal_set_message(t('Disabled these modules: !module-list.', array('!module-list' => implode(', ', $devel_modules))));
+ $rebuild = TRUE;
+ }
+ else {
+ drupal_set_message(t('No developer modules are enabled.'));
+ }
+ }
+ if ($rebuild) {
+ // Make sure everything is rebuilt, basically a combination of the calls
+ // from system_modules() and system_modules_submit().
+ drupal_theme_rebuild();
+ menu_rebuild();
+ cache_clear_all('schema', 'cache');
+ cache_clear_all();
+ drupal_clear_css_cache();
+ drupal_clear_js_cache();
+ // Synchronize to catch any actions that were added or removed.
+ actions_synchronize();
+ }
+ drupal_goto('');
+}
+
+/**
+ * Flush all caches or a specific one.
+ *
+ * @param $name
+ * (optional) Name of cache to flush.
+ */
+function admin_menu_flush_cache($name = NULL) {
+ switch ($name) {
+ case 'admin_menu':
+ admin_menu_flush_caches();
+ break;
+
+ case 'cache':
+ // Don't clear cache_form - in-progress form submissions may break.
+ // Ordered so clearing the page cache will always be the last action.
+ $core = array('cache', 'cache_block', 'cache_filter', 'cache_page');
+ $cache_tables = array_merge(module_invoke_all('flush_caches'), $core);
+ foreach ($cache_tables as $table) {
+ cache_clear_all('*', $table, TRUE);
+ }
+ break;
+
+ case 'menu':
+ module_invoke('menu', 'rebuild');
+ break;
+
+ case 'requisites':
+ // Change query-strings on css/js files to enforce reload for all users.
+ _drupal_flush_css_js();
+
+ drupal_clear_css_cache();
+ drupal_clear_js_cache();
+ break;
+
+ case 'theme':
+ module_invoke('system', 'theme_data');
+ drupal_theme_rebuild();
+ break;
+
+ default:
+ // Flush all caches; no need to re-implement this.
+ if (drupal_function_exists('system_clear_cache_submit')) {
+ $form_state = array();
+ system_clear_cache_submit($form_state, NULL);
+ }
+ break;
+ }
+ drupal_goto();
+}
+
=== added file 'sites/all/modules/admin_menu/admin_menu.info'
--- sites/all/modules/admin_menu/admin_menu.info 1970-01-01 00:00:00 +0000
+++ sites/all/modules/admin_menu/admin_menu.info 2009-01-15 16:50:15 +0000
@@ -0,0 +1,15 @@
+; $Id: admin_menu.info,v 1.9 2008/11/30 12:50:23 sun Exp $
+name = Administration menu
+description = Provides a dropdown menu to most administrative tasks and other common destinations (to users with the proper permissions).
+package = Administration
+core = 7.x
+files[] = admin_menu.module
+files[] = admin_menu.inc
+files[] = admin_menu.install
+
+; Information added by drupal.org packaging script on 2008-12-17
+version = "7.x-1.x-dev"
+core = "7.x"
+project = "admin_menu"
+datestamp = "1229515229"
+
=== added file 'sites/all/modules/admin_menu/admin_menu.install'
--- sites/all/modules/admin_menu/admin_menu.install 1970-01-01 00:00:00 +0000
+++ sites/all/modules/admin_menu/admin_menu.install 2009-01-15 16:50:16 +0000
@@ -0,0 +1,44 @@
+condition('module', 'admin_menu')->execute();
+ menu_cache_clear_all();
+ // Delete variables.
+ variable_del('admin_menu_rebuild_links');
+ variable_del('admin_menu_devel_modules_enabled');
+ variable_del('admin_menu_margin_top');
+ variable_del('admin_menu_tweak_modules');
+}
+
+/**
+ * Ensure that admin_menu is rebuilt after upgrading to D6.
+ */
+function admin_menu_update_6000() {
+ $ret = array();
+ // Delete menu links.
+ db_delete('menu_links')->condition('module', 'admin_menu')->execute();
+ variable_set('admin_menu_rebuild_links', TRUE);
+ // Drop the {admin_menu} table in admin_menu_update_6000() on sites that used
+ // one of the later patches in #132524.
+ if (db_table_exists('admin_menu')) {
+ $ret[] = update_sql("DROP TABLE {admin_menu}");
+ }
+ return $ret;
+}
+
+/**
+ * Wipe and rebuild so we can switch the icon path to .
+ */
+function admin_menu_update_6001() {
+ $ret = array();
+ module_load_include('inc', 'admin_menu');
+ admin_menu_wipe();
+ $ret[] = array('success' => TRUE, 'query' => 'Administration menu links deleted for clean rebuild.');
+ return $ret;
+}
+
=== added file 'sites/all/modules/admin_menu/admin_menu.js'
--- sites/all/modules/admin_menu/admin_menu.js 1970-01-01 00:00:00 +0000
+++ sites/all/modules/admin_menu/admin_menu.js 2009-01-15 16:50:16 +0000
@@ -0,0 +1,50 @@
+/* $Id: admin_menu.js,v 1.13 2008/11/02 21:36:09 sun Exp $ */
+
+$(document).ready(function() {
+ // Apply margin-top if enabled; directly applying marginTop doesn't work in IE.
+ if ($('#admin-menu').size()) {
+ if (Drupal.settings.admin_menu.margin_top) {
+ $('body').addClass('admin-menu');
+ }
+ if (Drupal.settings.admin_menu.position_fixed) {
+ $('#admin-menu').css('position', 'fixed');
+ }
+ // Move page tabs into administration menu.
+ if (Drupal.settings.admin_menu.tweak_tabs) {
+ $('ul.tabs.primary li').each(function() {
+ $(this).addClass('admin-menu-tab').appendTo('#admin-menu > ul');
+ });
+ $('ul.tabs.secondary').appendTo('#admin-menu > ul > li.admin-menu-tab.active');
+ }
+ }
+
+ // Collapse fieldsets on Modules page. For why multiple selectors see #111719.
+ if (Drupal.settings.admin_menu.tweak_modules) {
+ $('#system-modules fieldset:not(.collapsed), #system-modules-1 fieldset:not(.collapsed)').addClass('collapsed');
+ }
+
+ // Hover emulation for IE 6.
+ if ($.browser.msie && parseInt(jQuery.browser.version) == 6) {
+ $('#admin-menu li').hover(function() {
+ $(this).addClass('iehover');
+ }, function() {
+ $(this).removeClass('iehover');
+ });
+ }
+
+ // Delayed mouseout.
+ $('#admin-menu li').hover(function() {
+ // Stop the timer.
+ clearTimeout(this.sfTimer);
+ // Display child lists.
+ $('> ul', this).css({left: 'auto', display: 'block'})
+ // Immediately hide nephew lists.
+ .parent().siblings('li').children('ul').css({left: '-999em', display: 'none'});
+ }, function() {
+ // Start the timer.
+ var uls = $('> ul', this);
+ this.sfTimer = setTimeout(function() {
+ uls.css({left: '-999em', display: 'none'});
+ }, 400);
+ });
+});
=== added file 'sites/all/modules/admin_menu/admin_menu.module'
--- sites/all/modules/admin_menu/admin_menu.module 1970-01-01 00:00:00 +0000
+++ sites/all/modules/admin_menu/admin_menu.module 2009-01-15 16:50:15 +0000
@@ -0,0 +1,325 @@
+' . t('The administration menu module provides a dropdown menu arranged for one- or two-click access to most administrative tasks and other common destinations (to users with the proper permissions). Administration menu also displays the number of anonymous and authenticated users, and allows modules to add their own custom menu items. Integration with the menu varies from module to module; the contributed module Devel, for instance, makes strong use of the administration menu module to provide quick access to development tools.', array('@drupal' => 'http://drupal.org/project/devel')) . '';
+ $output .= '' . t('The administration menu settings page allows you to modify some elements of the menu\'s behavior and appearance. Since the appearance of the menu is dependent on your site theme, substantial customizations require modifications to your site\'s theme and CSS files. See the advanced module README.txt file for more information on theme and CSS customizations.', array('@settings' => url('admin/settings/admin_menu'))) . '
';
+ $output .= '' . t('The menu items displayed in the administration menu depend upon the actual permissions of the viewer. First, the administration menu is only displayed to users in roles with the Access administration menu (admin_menu module) permission. Second, a user must be a member of a role with the Access administration pages (system module) permission to view administrative links. And, third, only currently permitted links are displayed; for example, if a user is not a member of a role with the permissions Administer permissions (user module) and Administer users (user module), the User management menu item is not displayed.') . '
';
+ return $output;
+ }
+}
+
+/**
+ * Implementation of hook_perm().
+ */
+function admin_menu_perm() {
+ return array(
+ 'access administration menu' => array(
+ 'title' => t('Access administration menu'),
+ 'description' => t('Display the administration menu at the top of each page.'),
+ ),
+ 'display drupal links' => array(
+ 'title' => t('Display Drupal links'),
+ 'description' => t('Provide Drupal.org links in the administration menu.'),
+ )
+ );
+}
+
+/**
+ * Implementation of hook_theme().
+ */
+function admin_menu_theme() {
+ return array(
+ 'admin_menu_item' => array(
+ 'arguments' => array('link' => '', 'has_children' => FALSE, 'menu' => '', 'in_active_trail' => FALSE, 'extra_class' => ''),
+ ),
+ 'admin_menu_icon' => array(
+ 'arguments' => array(),
+ ),
+ );
+}
+
+/**
+ * Implementation of hook_menu().
+ */
+function admin_menu_menu() {
+ $items = array();
+ $items['admin/settings/admin_menu'] = array(
+ 'title' => 'Administration menu',
+ 'description' => 'Adjust administration menu settings.',
+ 'page callback' => 'drupal_get_form',
+ 'page arguments' => array('admin_menu_theme_settings'),
+ 'access arguments' => array('administer site configuration'),
+ );
+ $items['admin_menu/toggle-modules'] = array(
+ 'page callback' => 'admin_menu_toggle_modules',
+ 'access arguments' => array('administer site configuration'),
+ 'type' => MENU_CALLBACK,
+ );
+ $items['admin_menu/flush-cache'] = array(
+ 'page callback' => 'admin_menu_flush_cache',
+ 'access arguments' => array('administer site configuration'),
+ 'type' => MENU_CALLBACK,
+ );
+ return $items;
+}
+
+/**
+ * Implementation of hook_init().
+ *
+ * We can't move this into admin_menu_footer(), because PHP-only based themes
+ * like chameleon load and output scripts and stylesheets in front of
+ * theme_closure(), so we ensure Admin menu's styles and scripts are loaded on
+ * all pages via hook_init().
+ */
+function admin_menu_init() {
+ if (user_access('access administration menu')) {
+ $path = drupal_get_path('module', 'admin_menu');
+ drupal_add_css($path . '/admin_menu.css', array('preprocess' => FALSE));
+ // Performance: Defer execution.
+ drupal_add_js($path . '/admin_menu.js', array('defer' => TRUE));
+
+ if ($setting = variable_get('admin_menu_margin_top', 1)) {
+ drupal_add_js(array('admin_menu' => array('margin_top' => $setting)), 'setting');
+ }
+ if ($setting = variable_get('admin_menu_position_fixed', 0)) {
+ drupal_add_js(array('admin_menu' => array('position_fixed' => $setting)), 'setting');
+ }
+ if ($setting = variable_get('admin_menu_tweak_tabs', 0)) {
+ drupal_add_js(array('admin_menu' => array('tweak_tabs' => $setting)), 'setting');
+ }
+ if ($_GET['q'] == 'admin/build/modules') {
+ drupal_add_js(array('admin_menu' => array('tweak_modules' => variable_get('admin_menu_tweak_modules', 0))), 'setting');
+ }
+ }
+}
+
+/**
+ * Suppress display of administration menu.
+ *
+ * This function should be called from within another module's page callback
+ * (preferably using module_invoke()) when the menu should not be displayed.
+ * This is useful for modules that implement popup pages or other special
+ * pages where the menu would be distracting or break the layout.
+ *
+ * @param $set
+ * Defaults to TRUE. If called before hook_footer, the menu will not be
+ * displayed. Calling with FALSE returns the suppression state.
+ */
+function admin_menu_suppress($set = TRUE) {
+ static $suppress = FALSE;
+ if (!empty($set)) {
+ $suppress = TRUE;
+ }
+ return $suppress;
+}
+
+/**
+ * Implementation of hook_footer().
+ *
+ * Admin menu was previously output via hook_block(), but suffered from
+ * theme-specific stylesheets that may be applied to layout blocks. We now
+ * output Admin menu in the footer to circumvent this.
+ *
+ * @todo Since admin_menu is rebuilt in the same request, we should be able
+ * to use a helper function instead of a variable to remind us to rebuild
+ * (variable_set() is slow).
+ */
+function admin_menu_footer($main = 0) {
+ if (!user_access('access administration menu') || admin_menu_suppress(FALSE)) {
+ return;
+ }
+
+ // Check for the flag indicating that we need to rebuild.
+ if (variable_get('admin_menu_rebuild_links', FALSE)) {
+ module_load_include('inc', 'admin_menu');
+ _admin_menu_rebuild_links();
+ variable_del('admin_menu_rebuild_links');
+ }
+
+ $content = '';
+ return $content;
+}
+
+/**
+ * Returns a rendered menu tree.
+ *
+ * @param $tree
+ * A data structure representing the tree as returned from menu_tree_data.
+ *
+ * @return string
+ * The complete, rendered administration menu.
+ */
+function admin_menu_tree_output($tree) {
+ $output = '';
+
+ foreach ($tree as $data) {
+ $extra_class = isset($data['link']['localized_options']['extra class']) ? $data['link']['localized_options']['extra class'] : NULL;
+ $link = admin_menu_item_link($data['link']);
+
+ if ($data['below']) {
+ $output .= theme('admin_menu_item', $link, $data['link']['has_children'], admin_menu_tree_output($data['below']), $data['link']['in_active_trail'], $extra_class);
+ }
+ else {
+ $output .= theme('admin_menu_item', $link, $data['link']['has_children'], '', $data['link']['in_active_trail'], $extra_class);
+ }
+ }
+ return $output ? "\n' : '';
+}
+
+/**
+ * High-performance implementation of theme_menu_item_link().
+ *
+ * This saves us a theme() call and does only the absolute minimum to get
+ * the admin menu links rendered.
+ */
+function admin_menu_item_link($link) {
+ // Omit alias lookups.
+ $link['localized_options']['alias'] = TRUE;
+ return ''. (!empty($link['localized_options']['html']) ? $link['title'] : check_plain($link['title'])) .'';
+}
+
+/**
+ * Generate the HTML output for a single menu item and submenu.
+ *
+ * @param string $link
+ * A rendered menu item link.
+ * @param bool $has_children
+ * Whether this item has children.
+ * @param string $menu
+ * A string containing any rendered children of this item.
+ * @param bool $in_active_trail
+ * Whether this item is in the active menu trail.
+ * @param string $extra_class
+ * An additional CSS class to set for this item.
+ *
+ * @see theme_menu_item()
+ * @ingroup themeable
+ */
+function theme_admin_menu_item($link, $has_children, $menu = '', $in_active_trail = FALSE, $extra_class = NULL) {
+ $class = ($menu || $has_children ? 'expandable' : '');
+ if (!empty($extra_class)) {
+ $class .= ' '. $extra_class;
+ }
+ if ($in_active_trail) {
+ $class .= ' active-trail';
+ }
+ return ''. $link . $menu .'';
+}
+
+/**
+ * Implementation of hook_form_[form_id]_alter().
+ *
+ * Extends Devel module with Administration Menu developer settings.
+ */
+function admin_menu_form_devel_admin_settings_alter(&$form, $form_state) {
+ module_load_include('inc', 'admin_menu');
+ _admin_menu_devel_settings_form_alter($form, $form_state);
+}
+
+/**
+ * Implementation of hook_enable().
+ */
+function admin_menu_enable() {
+ variable_set('admin_menu_rebuild_links', TRUE);
+}
+
+/**
+ * Implementation of hook_menu_alter().
+ */
+function admin_menu_menu_alter() {
+ variable_set('admin_menu_rebuild_links', TRUE);
+}
+
+/**
+ * Implementation of hook_translated_menu_link_alter().
+ *
+ * Here is where we make changes to links that need dynamic information such
+ * as the current page path or the number of users.
+ */
+function admin_menu_translated_menu_link_alter(&$item, $map) {
+ global $user, $base_url;
+ static $access_all;
+
+ if (!isset($access_all)) {
+ // We only ever do this for development
+ $access_all = variable_get('admin_menu_show_all', 0) && module_exists('devel');
+ }
+ if ($item['menu_name'] != 'admin_menu') {
+ return;
+ }
+ if ($access_all && !$item['access']) {
+ $item['access'] = TRUE;
+ // Prepare for http://drupal.org/node/266596
+ if (!isset($item['localized_options'])) {
+ _menu_item_localize($item, $map, TRUE);
+ }
+ }
+ // Don't waste cycles altering items that are not visible
+ if (!$item['access']) {
+ return;
+ }
+ if ($item['link_path'] == $base_url . '/update.php' && $user->uid != 1) {
+ $item['access'] = FALSE;
+ return;
+ }
+ if ($item['link_path'] == 'http://drupal.org' && !user_access('display drupal links')) {
+ $item['access'] = FALSE;
+ return;
+ }
+ // Fix destination query strings
+ if (isset($item['localized_options']['query'])) {
+ if ($item['localized_options']['query'] == 'destination') {
+ $item['localized_options']['query'] = drupal_get_destination();
+ }
+ }
+ if ($extra = variable_get('admin_menu_display', 0)) {
+ $item['title'] .= ' '. $extra[0] .': '. $item[$extra];
+ }
+ // Handle items that need dynamic localization/replacement.
+ if (isset($item['options']['t'])) {
+ $item['title'] = t($item['title'], $item['options']['t'] + array('@username' => $GLOBALS['user']->name));
+ }
+ if ($item['title'] == 'icon_users') {
+ // Add count of active anonymous/authenticated users.
+ // @see user_block(), user.module
+ $interval = REQUEST_TIME - variable_get('user_block_seconds_online', 900);
+ $count_anon = drupal_session_count($interval, TRUE);
+ $count_auth = drupal_session_count($interval, FALSE);
+ $icon_users = ' . drupal_get_path('module', 'admin_menu') .'/images/icon_users.png "@title")
';
+
+ $title = array('@title' => t('Current anonymous / authenticated users'));
+ $icon_users = strtr($icon_users, $title);
+ $item['title'] = t('@count-anon / @count-auth !icon', array('@count-anon' => $count_anon, '@count-auth' => $count_auth, '!icon' => $icon_users));
+ if (user_access('administer users')) {
+ $item['href'] = 'admin/user/user';
+ }
+ }
+}
+
+/**
+ * Render an icon to display in the Administration Menu.
+ *
+ * @ingroup themeable
+ */
+function theme_admin_menu_icon() {
+ return '';
+}
+
=== added directory 'sites/all/modules/admin_menu/images'
=== added file 'sites/all/modules/admin_menu/images/arrow-rtl.png'
Binary files sites/all/modules/admin_menu/images/arrow-rtl.png 1970-01-01 00:00:00 +0000 and sites/all/modules/admin_menu/images/arrow-rtl.png 2009-01-15 16:50:16 +0000 differ
=== added file 'sites/all/modules/admin_menu/images/arrow.png'
Binary files sites/all/modules/admin_menu/images/arrow.png 1970-01-01 00:00:00 +0000 and sites/all/modules/admin_menu/images/arrow.png 2009-01-15 16:50:15 +0000 differ
=== added file 'sites/all/modules/admin_menu/images/bkg.png'
Binary files sites/all/modules/admin_menu/images/bkg.png 1970-01-01 00:00:00 +0000 and sites/all/modules/admin_menu/images/bkg.png 2009-01-15 16:50:16 +0000 differ
=== added file 'sites/all/modules/admin_menu/images/bkg_tab.png'
Binary files sites/all/modules/admin_menu/images/bkg_tab.png 1970-01-01 00:00:00 +0000 and sites/all/modules/admin_menu/images/bkg_tab.png 2009-01-15 16:50:16 +0000 differ
=== added file 'sites/all/modules/admin_menu/images/icon_users.png'
Binary files sites/all/modules/admin_menu/images/icon_users.png 1970-01-01 00:00:00 +0000 and sites/all/modules/admin_menu/images/icon_users.png 2009-01-15 16:50:16 +0000 differ
=== added directory 'sites/all/modules/admin_menu/tests'
=== added file 'sites/all/modules/admin_menu/tests/admin_menu.test.skip'
--- sites/all/modules/admin_menu/tests/admin_menu.test.skip 1970-01-01 00:00:00 +0000
+++ sites/all/modules/admin_menu/tests/admin_menu.test.skip 2009-01-15 16:50:15 +0000
@@ -0,0 +1,52 @@
+ t('Admin menu functionality'),
+ 'description' => t('Enable a module, make sure an admin user can see the new link.'),
+ 'group' => t('Admin menu tests'),
+ );
+ }
+
+ function setUp() {
+ parent::setUp('admin_menu');
+ }
+
+ /**
+ * Test that the links are added to the page (no JS testing).
+ */
+ function testAdminMenu() {
+ // Anonymous users should not see the menu.
+ $this->assertNoRaw('