1041 lines
38 KiB
PHP
1041 lines
38 KiB
PHP
<?php
|
|
// $Id$
|
|
|
|
/**
|
|
* @file
|
|
* Field attach API, allowing objects (nodes, users, ...) to be 'fieldable'.
|
|
*/
|
|
|
|
// TODO D7 : consistency - do field_attach_functions return a value or alter in place ?
|
|
|
|
// TODO D7 : consistency - some of these functions process individual fields
|
|
// and others process the combined value of all fields.
|
|
// Should all iteration through available fields be done here instead of in Field?
|
|
|
|
/**
|
|
* Exception thrown by field_attach_validate() on field validation errors.
|
|
*/
|
|
class FieldValidationException extends FieldException {
|
|
var $errors;
|
|
|
|
/**
|
|
* Constructor for FieldValidationException.
|
|
*
|
|
* @param $errors
|
|
* An array of field validation errors, keyed by field name and
|
|
* delta that contains two keys:
|
|
* - 'error': A machine-readable error code string, prefixed by
|
|
* the field module name. A field widget may use this code to decide
|
|
* how to report the error.
|
|
* - 'message': A human-readable error message such as to be
|
|
* passed to form_error() for the appropriate form element.
|
|
*/
|
|
function __construct($errors) {
|
|
$this->errors = $errors;
|
|
parent::__construct(t('Field validation errors'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Exception thrown by field_attach_query() on unsupported query syntax.
|
|
*
|
|
* Some storage modules might not support the full range of the syntax for
|
|
* conditions, and will raise a FieldQueryException when an usupported
|
|
* condition was specified.
|
|
*/
|
|
class FieldQueryException extends FieldException {}
|
|
|
|
/**
|
|
* @defgroup field_storage Field Storage API
|
|
* @{
|
|
* Implement a storage engine for Field API data.
|
|
*
|
|
* The Field Attach API uses the Field Storage API to perform all
|
|
* "database access". Each Field Storage API hook function defines a
|
|
* primitive database operation such as read, write, or delete. The
|
|
* default field storage module, field_sql_storage.module, uses the
|
|
* local SQL database to implement these operations, but alternative
|
|
* field storage engines can choose to represent the data in SQL
|
|
* differently or use a completely different storage mechanism such as
|
|
* a cloud-based database.
|
|
*
|
|
* The Drupal system variable field_storage_module identifies the
|
|
* field storage module to use.
|
|
*/
|
|
|
|
/**
|
|
* Argument for an insert operation.
|
|
* This is used in hook_field_storage_write when updating an
|
|
* existing object.
|
|
*/
|
|
define('FIELD_STORAGE_UPDATE', 'update');
|
|
|
|
/**
|
|
* Argument for an update operation.
|
|
* This is used in hook_field_storage_write when inserting a new object.
|
|
*/
|
|
define('FIELD_STORAGE_INSERT', 'insert');
|
|
|
|
/**
|
|
* @} End of "defgroup field_storage"
|
|
*/
|
|
|
|
/**
|
|
* @defgroup field_attach Field Attach API
|
|
* @{
|
|
* Operate on Field API data attached to Drupal objects.
|
|
*
|
|
* Field Attach API functions load, store, generate Form API
|
|
* structures, display, and perform a vareity of other functions for
|
|
* field data connected to individual objects.
|
|
*
|
|
* Field Attach API functions generally take $obj_type and $object
|
|
* arguments along with additional function-specific arguments.
|
|
* $obj_type is the type of the fieldable entity, such as 'node' or
|
|
* 'user', and $object is the object itself. An individual object's
|
|
* bundle, if any, is read from the object's bundle key property
|
|
* identified by hook_fieldable_info() for $obj_type.
|
|
*
|
|
* Fieldable types call Field Attach API functions during their own
|
|
* API calls; for example, node_load() calls field_attach_load(). A
|
|
* fieldable type is not required to use all of the Field Attach
|
|
* API functions.
|
|
*
|
|
* Most Field Attach API functions define a corresponding hook
|
|
* function that allows any module to act on Field Attach operations
|
|
* for any object after the operation is complete, and access or
|
|
* modify all the field, form, or display data for that object and
|
|
* operation. For example, field_attach_view() invokes
|
|
* hook_field_attach_view_alter(). These all-module hooks are distinct from
|
|
* those of the Field Types API, such as hook_field_load(), that are
|
|
* only invoked for the module that defines a specific field type.
|
|
*
|
|
* field_attach_load(), field_attach_insert(), and
|
|
* field_attach_update() also define pre-operation hooks,
|
|
* e.g. hook_field_attach_pre_load(). These hooks run before the
|
|
* corresponding Field Storage API and Field Type API operations.
|
|
* They allow modules to define additional storage locations
|
|
* (e.g. denormalizing, mirroring) for field data on a per-field
|
|
* basis. They also allow modules to take over field storage
|
|
* completely by instructing other implementations of the same hook
|
|
* and the Field Storage API itself not to operate on specified
|
|
* fields.
|
|
*
|
|
* The pre-operation hooks do not make the Field Storage API
|
|
* irrelevant. The Field Storage API is essentially the "fallback
|
|
* mechanism" for any fields that aren't being intercepted explicitly
|
|
* by pre-operation hooks.
|
|
*/
|
|
|
|
/**
|
|
* Invoke a field hook.
|
|
*
|
|
* @param $op
|
|
* Possible operations include:
|
|
* - form
|
|
* - validate
|
|
* - presave
|
|
* - insert
|
|
* - update
|
|
* - delete
|
|
* - delete revision
|
|
* - sanitize
|
|
* - view
|
|
* - prepare translation
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The fully formed $obj_type object.
|
|
* @param $a
|
|
* - The $form in the 'form' operation.
|
|
* - The value of $build_mode in the 'view' operation.
|
|
* - Otherwise NULL.
|
|
* @param $b
|
|
* - The $form_state in the 'submit' operation.
|
|
* - Otherwise NULL.
|
|
* @param $options
|
|
* An associative array of additional options, with the following keys:
|
|
* - 'field_name'
|
|
* The name of the field whose operation should be invoked. By default, the
|
|
* operation is invoked on all the fields in the object's bundle.
|
|
* - 'default'
|
|
* A boolean value, specifying which implementation of the operation should
|
|
* be invoked.
|
|
* - if FALSE (default), the field types implementation of the operation
|
|
* will be invoked (hook_field_[op])
|
|
* - If TRUE, the default field implementation of the field operation
|
|
* will be invoked (field_default_[op])
|
|
* Internal use only. Do not explicitely set to TRUE, but use
|
|
* _field_invoke_default() instead.
|
|
*/
|
|
function _field_invoke($op, $obj_type, $object, &$a = NULL, &$b = NULL, $options = array()) {
|
|
// Merge default options.
|
|
$default_options = array(
|
|
'default' => FALSE,
|
|
);
|
|
$options += $default_options;
|
|
|
|
// Iterate through the object's field instances.
|
|
$return = array();
|
|
list(, , $bundle) = field_attach_extract_ids($obj_type, $object);
|
|
foreach (field_info_instances($bundle) as $instance) {
|
|
$field_name = $instance['field_name'];
|
|
|
|
// When in 'single field' mode, only act on the specified field.
|
|
if (empty($options['field_name']) || $options['field_name'] == $field_name) {
|
|
$field = field_info_field($field_name);
|
|
|
|
// Extract the field values into a separate variable, easily accessed by
|
|
// hook implementations.
|
|
$items = isset($object->$field_name) ? $object->$field_name : array();
|
|
|
|
// Invoke the field hook and collect results.
|
|
$function = $options['default'] ? 'field_default_' . $op : $field['module'] . '_field_' . $op;
|
|
if (drupal_function_exists($function)) {
|
|
$result = $function($obj_type, $object, $field, $instance, $items, $a, $b);
|
|
if (isset($result)) {
|
|
// For hooks with array results, we merge results together.
|
|
// For hooks with scalar results, we collect results in an array.
|
|
if (is_array($result)) {
|
|
$return = array_merge($return, $result);
|
|
}
|
|
else {
|
|
$return[] = $result;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Populate field values back in the object, but avoid replacing missing
|
|
// fields with an empty array (those are not equivalent on update).
|
|
if ($items !== array() || property_exists($object, $field_name)) {
|
|
$object->$field_name = $items;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Invoke a field hook across fields on multiple objects.
|
|
*
|
|
* @param $op
|
|
* Possible operations include:
|
|
* - load
|
|
* For all other operations, use _field_invoke() / field_invoke_default()
|
|
* instead.
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $objects
|
|
* An array of objects, keyed by object id.
|
|
* @param $a
|
|
* - The $age parameter in the 'load' operation.
|
|
* - Otherwise NULL.
|
|
* @param $b
|
|
* Currently always NULL.
|
|
* @param $options
|
|
* An associative array of additional options, with the following keys:
|
|
* - 'field_name'
|
|
* The name of the field whose operation should be invoked. By default, the
|
|
* operation is invoked on all the fields in the objects' bundles.
|
|
* - 'default'
|
|
* A boolean value, specifying which implementation of the operation should
|
|
* be invoked.
|
|
* - if FALSE (default), the field types implementation of the operation
|
|
* will be invoked (hook_field_[op])
|
|
* - If TRUE, the default field implementation of the field operation
|
|
* will be invoked (field_default_[op])
|
|
* Internal use only. Do not explicitely set to TRUE, but use
|
|
* _field_invoke_multiple_default() instead.
|
|
* @return
|
|
* An array of returned values keyed by object id.
|
|
*/
|
|
function _field_invoke_multiple($op, $obj_type, $objects, &$a = NULL, &$b = NULL, $options = array()) {
|
|
// Merge default options.
|
|
$default_options = array(
|
|
'default' => FALSE,
|
|
);
|
|
$options += $default_options;
|
|
|
|
$fields = array();
|
|
$grouped_instances = array();
|
|
$grouped_objects = array();
|
|
$grouped_items = array();
|
|
$return = array();
|
|
|
|
// Go through the objects and collect the fields on which the hook should be
|
|
// invoked.
|
|
foreach ($objects as $object) {
|
|
list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $object);
|
|
foreach (field_info_instances($bundle) as $instance) {
|
|
$field_name = $instance['field_name'];
|
|
// When in 'single field' mode, only act on the specified field.
|
|
if (empty($options['field_name']) || $options['field_name'] == $field_name) {
|
|
// Add the field to the list of fields to invoke the hook on.
|
|
if (!isset($fields[$field_name])) {
|
|
$fields[$field_name] = field_info_field($field_name);
|
|
}
|
|
// Group the corresponding instances and objects.
|
|
$grouped_instances[$field_name][$id] = $instance;
|
|
$grouped_objects[$field_name][$id] = $objects[$id];
|
|
// Extract the field values into a separate variable, easily accessed
|
|
// by hook implementations.
|
|
$grouped_items[$field_name][$id] = isset($object->$field_name) ? $object->$field_name : array();
|
|
}
|
|
}
|
|
// Initialize the return value for each object.
|
|
$return[$id] = array();
|
|
}
|
|
|
|
// For each field, invoke the field hook and collect results.
|
|
foreach ($fields as $field_name => $field) {
|
|
$function = $options['default'] ? 'field_default_' . $op : $field['module'] . '_field_' . $op;
|
|
if (drupal_function_exists($function)) {
|
|
$results = $function($obj_type, $grouped_objects[$field_name], $field, $grouped_instances[$field_name], $grouped_items[$field_name], $a, $b);
|
|
if (isset($results)) {
|
|
// Collect results by object.
|
|
// For hooks with array results, we merge results together.
|
|
// For hooks with scalar results, we collect results in an array.
|
|
foreach ($results as $id => $result) {
|
|
if (is_array($result)) {
|
|
$return[$id] = array_merge($return[$id], $result);
|
|
}
|
|
else {
|
|
$return[$id][] = $result;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Populate field values back in the objects, but avoid replacing missing
|
|
// fields with an empty array (those are not equivalent on update).
|
|
foreach ($grouped_objects[$field_name] as $id => $object) {
|
|
if ($grouped_items[$field_name][$id] !== array() || property_exists($object, $field_name)) {
|
|
$object->$field_name = $grouped_items[$field_name][$id];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Invoke field.module's version of a field hook.
|
|
*
|
|
* This function invokes the field_default_[op]() function.
|
|
* Use _field_invoke() to invoke the field type implementation,
|
|
* hook_field_[op]().
|
|
*
|
|
* @see _field_invoke().
|
|
*/
|
|
function _field_invoke_default($op, $obj_type, $object, &$a = NULL, &$b = NULL, $options = array()) {
|
|
$options['default'] = TRUE;
|
|
return _field_invoke($op, $obj_type, $object, $a, $b, $options);
|
|
}
|
|
|
|
/**
|
|
* Invoke field.module's version of a field hook on multiple objects.
|
|
*
|
|
* This function invokes the field_default_[op]() function.
|
|
* Use _field_invoke_multiple() to invoke the field type implementation,
|
|
* hook_field_[op]().
|
|
*
|
|
* @see _field_invoke_multiple().
|
|
*/
|
|
function _field_invoke_multiple_default($op, $obj_type, $objects, &$a = NULL, &$b = NULL, $options = array()) {
|
|
$options['default'] = TRUE;
|
|
return _field_invoke_multiple($op, $obj_type, $objects, $a, $b, $options);
|
|
}
|
|
|
|
/**
|
|
* Add form elements for all fields for an object to a form structure.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object for which to load form elements, used to initialize
|
|
* default form values.
|
|
* @param $form
|
|
* The form structure to fill in.
|
|
* @param $form_state
|
|
* An associative array containing the current state of the form.
|
|
*
|
|
* TODO : document the resulting $form structure, like we do for
|
|
* field_attach_view().
|
|
*/
|
|
function field_attach_form($obj_type, $object, &$form, &$form_state) {
|
|
// TODO : something's not right here : do we alter the form or return a value ?
|
|
$form += (array) _field_invoke_default('form', $obj_type, $object, $form, $form_state);
|
|
|
|
// Let other modules make changes to the form.
|
|
foreach (module_implements('field_attach_form') as $module) {
|
|
$function = $module . '_field_attach_form';
|
|
$function($obj_type, $object, $form, $form_state);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load all fields for the most current version of each of a set of
|
|
* objects of a single object type.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $objects
|
|
* An array of objects for which to load fields, keyed by object id.
|
|
* Each object needs to have its 'bundle key', 'id key' and (if applicable)
|
|
* 'revision key' filled.
|
|
* @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. Defaults to FIELD_LOAD_CURRENT; use
|
|
* field_attach_load_revision() instead of passing FIELD_LOAD_REVISION.
|
|
* @returns
|
|
* Loaded field values are added to $objects. Fields with no values should be
|
|
* set as an empty array.
|
|
*/
|
|
function field_attach_load($obj_type, $objects, $age = FIELD_LOAD_CURRENT) {
|
|
$load_current = $age == FIELD_LOAD_CURRENT;
|
|
|
|
$info = field_info_fieldable_types($obj_type);
|
|
$cacheable = $load_current && $info['cacheable'];
|
|
|
|
if (empty($objects)) {
|
|
return;
|
|
}
|
|
|
|
// Assume all objects will need to be queried. Objects found in the cache
|
|
// will be removed from the list.
|
|
$queried_objects = $objects;
|
|
|
|
// Fetch available objects from cache, if applicable.
|
|
if ($cacheable) {
|
|
// Build the list of cache entries to retrieve.
|
|
$cids = array();
|
|
foreach ($objects as $id => $object) {
|
|
$cids[] = "field:$obj_type:$id";
|
|
}
|
|
$cache = cache_get_multiple($cids, 'cache_field');
|
|
// Put the cached field values back into the objects and remove them from
|
|
// the list of objects to query.
|
|
foreach ($objects as $id => $object) {
|
|
$cid = "field:$obj_type:$id";
|
|
if (isset($cache[$cid])) {
|
|
unset($queried_objects[$id]);
|
|
foreach ($cache[$cid]->data as $field_name => $values) {
|
|
$object->$field_name = $values;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Fetch other objects from their storage location.
|
|
if ($queried_objects) {
|
|
// The invoke order is:
|
|
// - hook_field_attach_pre_load()
|
|
// - storage engine's hook_field_storage_load()
|
|
// - field-type module's hook_field_load()
|
|
// - hook_field_attach_load()
|
|
|
|
// Invoke hook_field_attach_pre_load(): let any module load field
|
|
// data before the storage engine, accumulating along the way.
|
|
$skip_fields = array();
|
|
foreach (module_implements('field_attach_pre_load') as $module) {
|
|
$function = $module . '_field_attach_pre_load';
|
|
$function($obj_type, $queried_objects, $age, $skip_fields);
|
|
}
|
|
|
|
// Invoke the storage engine's hook_field_storage_load(): the field storage
|
|
// engine loads the rest.
|
|
module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'field_storage_load', $obj_type, $queried_objects, $age, $skip_fields);
|
|
|
|
// Invoke field-type module's hook_field_load().
|
|
_field_invoke_multiple('load', $obj_type, $queried_objects, $age);
|
|
|
|
// Invoke hook_field_attach_load(): 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_objects, $age);
|
|
}
|
|
|
|
// Build cache data.
|
|
if ($cacheable) {
|
|
foreach ($queried_objects as $id => $object) {
|
|
$data = array();
|
|
list($id, $vid, $bundle) = field_attach_extract_ids($obj_type, $object);
|
|
$instances = field_info_instances($bundle);
|
|
foreach ($instances as $instance) {
|
|
$data[$instance['field_name']] = $queried_objects[$id]->{$instance['field_name']};
|
|
}
|
|
$cid = "field:$obj_type:$id";
|
|
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.
|
|
*
|
|
* Loading different versions of the same objects is not supported,
|
|
* and should be done by separate calls to the function.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $objects
|
|
* An array of objects for which to load fields, keyed by object id.
|
|
* Each object needs to have its 'bundle key', 'id key' and 'revision key'
|
|
* filled.
|
|
* @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);
|
|
}
|
|
|
|
/**
|
|
* Perform field validation against the field data in an object.
|
|
*
|
|
* This function does not perform field widget validation on form
|
|
* submissions. It is intended to be called during API save
|
|
* operations. Use field_attach_form_validate() to validate form
|
|
* submissions.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object with fields to validate.
|
|
* @return
|
|
* Throws a FieldValidationException if validation errors are found.
|
|
*/
|
|
function field_attach_validate($obj_type, $object) {
|
|
$errors = array();
|
|
_field_invoke_default('validate', $obj_type, $object, $errors);
|
|
_field_invoke('validate', $obj_type, $object, $errors);
|
|
|
|
// Let other modules validate the object.
|
|
foreach (module_implements('field_attach_validate') as $module) {
|
|
$function = $module . '_field_attach_validate';
|
|
$function($obj_type, $object, $errors);
|
|
}
|
|
|
|
if ($errors) {
|
|
throw new FieldValidationException($errors);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Perform field validation against form-submitted field values.
|
|
*
|
|
* There are two levels of validation for fields in forms: widget
|
|
* validation, and field validation.
|
|
* - Widget validation steps are specific to a given widget's own form
|
|
* structure and UI metaphors. They are executed through FAPI's
|
|
* #element_validate property during normal form validation.
|
|
* - Field validation steps are common to a given field type, independently of
|
|
* the specific widget being used in a given form. They are defined in the
|
|
* field type's implementation of hook_field_validate().
|
|
*
|
|
* This function performs field validation in the context of a form
|
|
* submission. It converts field validation errors into form errors
|
|
* on the correct form elements. Fieldable object types should call
|
|
* this function during their own form validation function.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object being submitted. The 'bundle key', 'id key' and (if applicable)
|
|
* 'revision key' should be present. The actual field values will be read
|
|
* from $form_state['values'].
|
|
* @param $form
|
|
* The form structure.
|
|
* @param $form_state
|
|
* An associative array containing the current state of the form.
|
|
*/
|
|
function field_attach_form_validate($obj_type, $object, $form, &$form_state) {
|
|
// Extract field values from submitted values.
|
|
_field_invoke_default('extract_form_values', $obj_type, $object, $form, $form_state);
|
|
|
|
// Perform field_level validation.
|
|
try {
|
|
field_attach_validate($obj_type, $object);
|
|
}
|
|
catch (FieldValidationException $e) {
|
|
// Pass field-level validation errors back to widgets for accurate error
|
|
// flagging.
|
|
_field_invoke_default('form_errors', $obj_type, $object, $form, $e->errors);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Perform necessary operations on field data submitted by a form.
|
|
*
|
|
* Currently, this accounts for drag-and-drop reordering of
|
|
* field values, and filtering of empty values.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object being submitted. The 'bundle key', 'id key' and (if applicable)
|
|
* 'revision key' should be present. The actual field values will be read
|
|
* from $form_state['values'].
|
|
* @param $form
|
|
* The form structure to fill in.
|
|
* @param $form_state
|
|
* An associative array containing the current state of the form.
|
|
*/
|
|
function field_attach_submit($obj_type, $object, $form, &$form_state) {
|
|
// Extract field values from submitted values.
|
|
_field_invoke_default('extract_form_values', $obj_type, $object, $form, $form_state);
|
|
|
|
_field_invoke_default('submit', $obj_type, $object, $form, $form_state);
|
|
|
|
// Let other modules act on submitting the object.
|
|
foreach (module_implements('field_attach_submit') as $module) {
|
|
$function = $module . '_field_attach_submit';
|
|
$function($obj_type, $object, $form, $form_state);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Perform necessary operations just before fields data get saved.
|
|
*
|
|
* We take no specific action here, we just give other
|
|
* modules the opportunity to act.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object with fields to process.
|
|
*/
|
|
function field_attach_presave($obj_type, $object) {
|
|
// TODO : to my knowledge, no field module has any use for 'presave' on D6.
|
|
// should we keep this ?
|
|
_field_invoke('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);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save field data for a new object.
|
|
*
|
|
* The passed in object must already contain its id and (if applicable)
|
|
* revision id attributes.
|
|
* Default values (if any) will be saved for fields not present in the
|
|
* $object.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object with fields to save.
|
|
* @return
|
|
* Default values (if any) will be added to the $object parameter for fields
|
|
* it leaves unspecified.
|
|
*/
|
|
function field_attach_insert($obj_type, $object) {
|
|
_field_invoke_default('insert', $obj_type, $object);
|
|
_field_invoke('insert', $obj_type, $object);
|
|
|
|
// Let other modules act on inserting the object, accumulating saved
|
|
// fields along the way.
|
|
$skip_fields = array();
|
|
foreach (module_implements('field_attach_pre_insert') as $module) {
|
|
$function = $module . '_field_attach_pre_insert';
|
|
$function($obj_type, $object, $skip_fields);
|
|
}
|
|
|
|
// Field storage module saves any remaining unsaved fields.
|
|
module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'field_storage_write', $obj_type, $object, FIELD_STORAGE_INSERT, $skip_fields);
|
|
|
|
list($id, $vid, $bundle, $cacheable) = field_attach_extract_ids($obj_type, $object);
|
|
if ($cacheable) {
|
|
cache_clear_all("field:$obj_type:$id", 'cache_field');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save field data for an existing object.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object with fields to save.
|
|
*/
|
|
function field_attach_update($obj_type, $object) {
|
|
_field_invoke('update', $obj_type, $object);
|
|
|
|
// Let other modules act on updating the object, accumulating saved
|
|
// fields along the way.
|
|
$skip_fields = array();
|
|
foreach (module_implements('field_attach_pre_update') as $module) {
|
|
$function = $module . '_field_attach_pre_update';
|
|
$function($obj_type, $object, $skip_fields);
|
|
}
|
|
|
|
// Field storage module saves any remaining unsaved fields.
|
|
module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'field_storage_write', $obj_type, $object, FIELD_STORAGE_UPDATE, $skip_fields);
|
|
|
|
list($id, $vid, $bundle, $cacheable) = field_attach_extract_ids($obj_type, $object);
|
|
if ($cacheable) {
|
|
cache_clear_all("field:$obj_type:$id", 'cache_field');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete field data for an existing object. This deletes all
|
|
* revisions of field data for the object.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object whose field data to delete.
|
|
*/
|
|
function field_attach_delete($obj_type, $object) {
|
|
_field_invoke('delete', $obj_type, $object);
|
|
module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'field_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');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete field data for a single revision of an existing object. The
|
|
* passed object must have a revision id attribute.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object with fields to save.
|
|
*/
|
|
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'), 'field_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);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieve objects matching a given set of conditions.
|
|
*
|
|
* Note that the query 'conditions' only apply to the stored values.
|
|
* In a regular field_attach_load() call, field values additionally go through
|
|
* hook_field_load() and hook_field_attach_load() invocations, which can add
|
|
* to or affect the raw stored values. The results of field_attach_query()
|
|
* might therefore differ from what could be expected by looking at a regular,
|
|
* fully loaded object.
|
|
*
|
|
* @param $field_name
|
|
* The name of the field to query.
|
|
* @param $conditions
|
|
* An array of query conditions. Each condition is a numerically indexed
|
|
* array, in the form: array(column, value, operator).
|
|
* Not all storage engines are required to support queries on all column, or
|
|
* with all operators below. A FieldQueryException will be raised if an
|
|
* unsupported condition is specified.
|
|
* Supported columns:
|
|
* - any of the columns for $field_name's field type: condition on field
|
|
* value,
|
|
* - 'type': condition on object type (e.g. 'node', 'user'...),
|
|
* - 'bundle': condition on object bundle (e.g. node type),
|
|
* - 'entity_id': condition on object id (e.g node nid, user uid...),
|
|
* The field_attach_query_revisions() function additionally supports:
|
|
* - 'revision_id': condition on object revision id (e.g node vid).
|
|
* Supported operators:
|
|
* - '=', '!=', '>', '>=', '<', '<=', 'STARTS_WITH', 'ENDS_WITH',
|
|
* 'CONTAINS': these operators expect the value as a literal of the same
|
|
* type as the column,
|
|
* - 'IN', 'NOT IN': this operator expects the value as an array of
|
|
* literals of the same type as the column.
|
|
* - 'BETWEEN': this operator expects the value as an array of two literals
|
|
* of the same type as the column.
|
|
* The operator can be ommitted, and will default to 'IN' if the value is
|
|
* an array, or to '=' otherwise.
|
|
* Example values for $conditions:
|
|
* @code
|
|
* array(
|
|
* array('type', 'node'),
|
|
* );
|
|
* array(
|
|
* array('bundle', array('article', 'page')),
|
|
* array('value', 12, '>'),
|
|
* );
|
|
* @endcode
|
|
* @param $count
|
|
* The number of results that is requested. This is only a
|
|
* hint to the storage engine(s); callers should be prepared to
|
|
* handle fewer or more results. Specify FIELD_QUERY_NO_LIMIT to retrieve
|
|
* all available objects. This parameter has no default value so
|
|
* callers must make an explicit choice to potentially retrieve an
|
|
* enormous result set.
|
|
* @param &$cursor
|
|
* An opaque cursor that allows a caller to iterate through multiple
|
|
* result sets. On the first call, pass 0; the correct value to pass
|
|
* on the next call will be written into $cursor on return. If NULL,
|
|
* the first result set is returned and no next cursor is returned.
|
|
* @param $age
|
|
* Internal use only. Use field_attach_query_revisions() instead of passing
|
|
* FIELD_LOAD_REVISION.
|
|
* - FIELD_LOAD_CURRENT (default): query the most recent revisions for all
|
|
* objects. The results will be keyed by object type and object id.
|
|
* - FIELD_LOAD_REVISION: query all revisions. The results will be keyed by
|
|
* object type and object revision id.
|
|
* @return
|
|
* An array keyed by object type (e.g. 'node', 'user'...), then by object id
|
|
* or revision id (depending of the value of the $age parameter).
|
|
* The values are pseudo-objects with the bundle, id, and revision
|
|
* id fields filled in.
|
|
*
|
|
* Throws a FieldQueryException if the field's storage doesn't support the
|
|
* specified conditions.
|
|
*/
|
|
function field_attach_query($field_name, $conditions, $count, &$cursor = NULL, $age = FIELD_LOAD_CURRENT) {
|
|
if (!isset($cursor)) {
|
|
$cursor = 0;
|
|
}
|
|
|
|
// Give a chance to 3rd party modules that bypass the storage engine to
|
|
// handle the query.
|
|
$skip_field = FALSE;
|
|
foreach (module_implements('field_attach_pre_query') as $module) {
|
|
$function = $module . '_field_attach_pre_query';
|
|
$results = $function($field_name, $conditions, $count, $cursor, $age, $skip_field);
|
|
// Stop as soon as a module claims it handled the query.
|
|
if ($skip_field) {
|
|
break;
|
|
}
|
|
}
|
|
// If the request hasn't been handled, let the storage engine handle it.
|
|
if (!$skip_field) {
|
|
$results = module_invoke(variable_get('field_storage_module', 'field_sql_storage'), 'field_storage_query', $field_name, $conditions, $count, $cursor, $age);
|
|
}
|
|
|
|
return $results;
|
|
}
|
|
|
|
/**
|
|
* Retrieve object revisions matching a given set of conditions.
|
|
*
|
|
* See field_attach_query() for more informations.
|
|
*
|
|
* @param $field_name
|
|
* The name of the field to query.
|
|
* @param $conditions
|
|
* See field_attach_query().
|
|
* @param $count
|
|
* The number of results that is requested. This is only a
|
|
* hint to the storage engine(s); callers should be prepared to
|
|
* handle fewer or more results. Specify FIELD_QUERY_NO_LIMIT to retrieve
|
|
* all available objects. This parameter has no default value so
|
|
* callers must make an explicit choice to potentially retrieve an
|
|
* enormous result set.
|
|
* @param &$cursor
|
|
* An opaque cursor that allows a caller to iterate through multiple
|
|
* result sets. On the first call, pass 0; the correct value to pass
|
|
* on the next call will be written into $cursor on return.
|
|
* @return
|
|
* See field_attach_query().
|
|
*/
|
|
function field_attach_query_revisions($field_name, $conditions, $count, &$cursor = NULL) {
|
|
return field_attach_query($field_name, $conditions, $count, $cursor, FIELD_LOAD_REVISION);
|
|
}
|
|
|
|
/**
|
|
* Generate and return a structured content array tree suitable for
|
|
* drupal_render() for all of the fields on an object. The format of
|
|
* each field's rendered content depends on the display formatter and
|
|
* its settings.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object with fields to render.
|
|
* @param $build_mode
|
|
* Build mode, e.g. 'full', 'teaser'...
|
|
* @return
|
|
* A structured content array tree for drupal_render().
|
|
*/
|
|
function field_attach_view($obj_type, $object, $build_mode = 'full') {
|
|
// Let field modules sanitize their data for output.
|
|
_field_invoke('sanitize', $obj_type, $object);
|
|
|
|
$output = _field_invoke_default('view', $obj_type, $object, $build_mode);
|
|
|
|
// Let other modules make changes after rendering the view.
|
|
drupal_alter('field_attach_view', $output, $obj_type, $object, $build_mode);
|
|
|
|
return $output;
|
|
|
|
}
|
|
|
|
/**
|
|
* Implement hook_node_prepare_translation.
|
|
*
|
|
* TODO D7: We do not yet know if this really belongs in Field API.
|
|
*/
|
|
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'), 'field_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'), 'field_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) {
|
|
// Delete the instances themseves
|
|
$instances = field_info_instances($bundle);
|
|
foreach ($instances as $instance) {
|
|
field_delete_instance($instance['field_name'], $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, $instances);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Helper function to extract id, vid, and bundle name from an object.
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $object
|
|
* The object from which to extract values.
|
|
* @return
|
|
* A numerically indexed array (not a hash table) containing these
|
|
* elements:
|
|
*
|
|
* 0: primary id of the object
|
|
* 1: revision id of the object, or NULL if $obj_type is not versioned
|
|
* 2: bundle name of the object
|
|
* 3: whether $obj_type's fields should be cached (TRUE/FALSE)
|
|
*/
|
|
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 = $info['cacheable'];
|
|
return array($id, $vid, $bundle, $cacheable);
|
|
}
|
|
|
|
/**
|
|
* Helper function to assemble an object structure with initial ids.
|
|
*
|
|
* This function can be seen as reciprocal to field_attach_extract_ids().
|
|
*
|
|
* @param $obj_type
|
|
* The type of $object; e.g. 'node' or 'user'.
|
|
* @param $ids
|
|
* A numerically indexed array, as returned by field_attach_extract_ids(),
|
|
* containing these elements:
|
|
* 0: primary id of the object
|
|
* 1: revision id of the object, or NULL if $obj_type is not versioned
|
|
* 2: bundle name of the object
|
|
* @return
|
|
* An $object structure, initialized with the ids provided.
|
|
*/
|
|
function field_attach_create_stub_object($obj_type, $ids) {
|
|
$object = new stdClass();
|
|
$info = field_info_fieldable_types($obj_type);
|
|
$object->{$info['id key']} = $ids[0];
|
|
if (isset($info['revision key']) && !is_null($ids[1])) {
|
|
$object->{$info['revision key']} = $ids[1];
|
|
}
|
|
if ($info['bundle key']) {
|
|
$object->{$info['bundle key']} = $ids[2];
|
|
}
|
|
return $object;
|
|
}
|
|
|
|
/**
|
|
* @} End of "defgroup field_attach"
|
|
*/
|