Commit 375a7081 authored by alexpott's avatar alexpott

Issue #2067127 by yched: Reorganize the contents of field.* files.

parent 9ef3a52f
......@@ -6,11 +6,7 @@
*/
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityNG;
use Drupal\entity\Entity\EntityDisplay;
use Drupal\entity\Entity\EntityFormDisplay;
use Drupal\Core\Language\Language;
use Drupal\Core\Entity\Field\PrepareCacheInterface;
/**
* @defgroup field_storage Field Storage API
......@@ -394,722 +390,6 @@ function _field_invoke_widget_target($form_display) {
};
}
/**
* Adds form elements for all fields for an entity to a form structure.
*
* The form elements for the entity's fields are added by reference as direct
* children in the $form parameter. This parameter can be a full form structure
* (most common case for entity edit forms), or a sub-element of a larger form.
*
* By default, submitted field values appear at the top-level of
* $form_state['values']. A different location within $form_state['values'] can
* be specified by setting the '#parents' property on the incoming $form
* parameter. Because of name clashes, two instances of the same field cannot
* appear within the same $form element, or within the same '#parents' space.
*
* For each call to field_attach_form(), field values are processed by calling
* field_attach_extract_form_values() on the same $form element.
*
* Sample resulting structure in $form:
* @code
* '#parents' => The location of field values in $form_state['values'],
* '#entity_type' => The name of the entity type,
* '#bundle' => The name of the bundle,
* // One sub-array per field appearing in the entity, keyed by field name.
* // The structure of the array differs slightly depending on whether the
* // widget is 'single-value' (provides the input for one field value,
* // most common case), and will therefore be repeated as many times as
* // needed, or 'multiple-values' (one single widget allows the input of
* // several values, e.g checkboxes, select box...).
* // The sub-array is nested into a $langcode key where $langcode has the
* // same value of the $langcode parameter above.
* // The '#language' key holds the same value of $langcode and it is used
* // to access the field sub-array when $langcode is unknown.
* 'field_foo' => array(
* '#tree' => TRUE,
* '#field_name' => The name of the field,
* '#language' => $langcode,
* $langcode => array(
* '#field_name' => The name of the field,
* '#language' => $langcode,
* '#field_parents' => The 'parents' space for the field in the form,
* equal to the #parents property of the $form parameter received by
* field_attach_form(),
* '#required' => Whether or not the field is required,
* '#title' => The label of the field instance,
* '#description' => The description text for the field instance,
*
* // Only for 'single' widgets:
* '#theme' => 'field_multiple_value_form',
* '#cardinality' => The field cardinality,
* // One sub-array per copy of the widget, keyed by delta.
* 0 => array(
* '#entity_type' => The name of the entity type,
* '#bundle' => The name of the bundle,
* '#field_name' => The name of the field,
* '#field_parents' => The 'parents' space for the field in the form,
* equal to the #parents property of the $form parameter received by
* field_attach_form(),
* '#title' => The title to be displayed by the widget,
* '#default_value' => The field value for delta 0,
* '#required' => Whether the widget should be marked required,
* '#delta' => 0,
* // The remaining elements in the sub-array depend on the widget.
* '#type' => The type of the widget,
* ...
* ),
* 1 => array(
* ...
* ),
*
* // Only for multiple widgets:
* '#entity_type' => The name of the entity type,
* '#bundle' => $instance['bundle'],
* // The remaining elements in the sub-array depend on the widget.
* '#type' => The type of the widget,
* ...
* ),
* ...
* ),
* )
* @endcode
*
* Additionally, some processing data is placed in $form_state, and can be
* accessed by field_form_get_state() and field_form_set_state().
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity for which to load form elements, used to initialize
* default form values.
* @param $form
* The form structure to fill in. This can be a full form structure, or a
* sub-element of a larger form. The #parents property can be set to control
* the location of submitted field values within $form_state['values']. If
* not specified, $form['#parents'] is set to an empty array, placing field
* values at the top-level of $form_state['values'].
* @param $form_state
* An associative array containing the current state of the form.
* @param $langcode
* The language the field values are going to be entered, if no language
* is provided the default site language will be used.
* @param array $options
* An associative array of additional options. See field_invoke_method() for
* details.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*
* @see field_form_get_state()
* @see field_form_set_state()
*/
function field_attach_form(EntityInterface $entity, &$form, &$form_state, $langcode = NULL, array $options = array()) {
// Ensure we are working with a BC mode entity.
$entity = $entity->getBCEntity();
// Set #parents to 'top-level' by default.
$form += array('#parents' => array());
// Get the entity_form_display object for this form.
$form_display = $form_state['form_display'];
// If no language is provided use the default site language.
$options['langcode'] = field_valid_language($langcode);
$form += (array) field_invoke_method('form', _field_invoke_widget_target($form_display), $entity, $form, $form_state, $options);
$form['#entity_type'] = $entity->entityType();
$form['#bundle'] = $entity->bundle();
// Let other modules make changes to the form.
// Avoid \Drupal::moduleHandler()->invokeAll()
// to let parameters be taken by reference.
foreach (Drupal::moduleHandler()->getImplementations('field_attach_form') as $module) {
$function = $module . '_field_attach_form';
$function($entity, $form, $form_state, $langcode);
}
}
/**
* Loads fields for the current revisions of a group of entities.
*
* Loads all fields for each entity object in a group of a single entity type.
* The loaded field values are added directly to the entity objects.
*
* field_attach_load() is automatically called by the default entity controller
* class, and thus, in most cases, doesn't need to be explicitly called by the
* entity type module.
*
* @param $entity_type
* The type of entities in $entities; e.g., 'node' or 'user'.
* @param $entities
* An array of entities for which to load fields, keyed by entity ID. Each
* entity needs to have its 'bundle', 'id' and (if applicable) 'revision' keys
* filled in. The function adds the loaded field data directly in the entity
* objects of the $entities array.
* @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 entity. Defaults
* to FIELD_LOAD_CURRENT; use field_attach_load_revision() instead of passing
* FIELD_LOAD_REVISION.
* @param $options
* An associative array of additional options, with the following keys:
* - instance: A field instance entity, If provided, only values for the
* corresponding field will be loaded, and no cache is written. This
* option is only supported when all $entities are within the same bundle.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_load($entity_type, $entities, $age = FIELD_LOAD_CURRENT, $options = array()) {
$load_current = $age == FIELD_LOAD_CURRENT;
$load_deleted = !empty($options['instance']->deleted);
// Merge default options.
$options += array('instance' => NULL);
// Set options for hook invocations.
$hook_options = array(
'deleted' => $load_deleted,
);
if ($options['instance']) {
$hook_options['field_id'] = $options['instance']->field_uuid;
}
$info = entity_get_info($entity_type);
// Only the most current revision of non-deleted fields for cacheable entity
// types can be cached.
$cache_read = $load_current && $info['field_cache'] && !$load_deleted;
// In addition, do not write to the cache when loading a single field.
$cache_write = $cache_read && !isset($options['instance']);
if (empty($entities)) {
return;
}
// Ensure we are working with a BC mode entity.
foreach ($entities as $id => $entity) {
$entities[$id] = $entity->getBCEntity();
}
// Assume all entities will need to be queried. Entities found in the cache
// will be removed from the list.
$queried_entities = $entities;
// Fetch available entities from cache, if applicable.
if ($cache_read) {
// Build the list of cache entries to retrieve.
$cids = array();
foreach ($entities as $id => $entity) {
$cids[] = "field:$entity_type:$id";
}
$cache = cache('field')->getMultiple($cids);
// Put the cached field values back into the entities and remove them from
// the list of entities to query.
foreach ($entities as $id => $entity) {
$cid = "field:$entity_type:$id";
if (isset($cache[$cid])) {
unset($queried_entities[$id]);
foreach ($cache[$cid]->data as $field_name => $values) {
$entity->$field_name = $values;
}
}
}
}
// Fetch other entities from their storage location.
if ($queried_entities) {
// The invoke order is:
// - hook_field_storage_pre_load()
// - storage backend's hook_field_storage_load()
// - Field class's prepareCache() method.
// - hook_field_attach_load()
// Invoke hook_field_storage_pre_load(): let any module load field
// data before the storage engine, accumulating along the way.
$skip_fields = array();
foreach (Drupal::moduleHandler()->getImplementations('field_storage_pre_load') as $module) {
$function = $module . '_field_storage_pre_load';
$function($entity_type, $queried_entities, $age, $skip_fields, $hook_options);
}
// Collect the storage backends used by the remaining fields in the entities.
$storages = array();
foreach ($queried_entities as $entity) {
$id = $entity->id();
$vid = $entity->getRevisionId();
// Determine the list of field instances to work on.
if ($options['instance']) {
$instances = array($options['instance']);
}
else {
$instances = field_info_instances($entity_type, $entity->bundle());
}
foreach ($instances as $instance) {
$field = $instance->getField();
$field_name = $field->id();
if (!isset($queried_entities[$id]->{$field_name})) {
$queried_entities[$id]->{$field_name} = array();
}
if (!isset($skip_fields[$field->uuid])) {
$storages[$field->storage['type']][$field->uuid][] = $load_current ? $id : $vid;
}
}
}
// Invoke hook_field_storage_load() on the relevant storage backends.
foreach ($storages as $storage => $fields) {
$storage_info = field_info_storage_types($storage);
module_invoke($storage_info['module'], 'field_storage_load', $entity_type, $queried_entities, $age, $fields, $hook_options);
}
// Invoke the field type's prepareCache() method.
if (empty($options['instance'])) {
foreach ($queried_entities as $entity) {
\Drupal::entityManager()
->getStorageController($entity_type)
->invokeFieldItemPrepareCache($entity);
}
}
else {
// Do not rely on invokeFieldItemPrepareCache(), which only works on
// fields listed in getFieldDefinitions(), and will fail if we are loading
// values for a deleted field. Instead, generate FieldItem objects
// directly, and call their prepareCache() method.
foreach ($queried_entities as $entity) {
$field = $options['instance']->getField();
$field_name = $field->id();
// Call the prepareCache() method on each item.
foreach ($entity->{$field_name} as $langcode => $values) {
$definition = _field_generate_entity_field_definition($field, $options['instance']);
$items = \Drupal::typedData()->create($definition, $values, $field_name, $entity);
foreach ($items as $item) {
if ($item instanceof PrepareCacheInterface) {
$item->prepareCache();
}
}
$entity->{$field_name}[$langcode] = $items->getValue();
}
}
}
// Invoke hook_field_attach_load(): let other modules act on loading the
// entity.
Drupal::moduleHandler()->invokeAll('field_attach_load', $entity_type, $queried_entities, $age, $options);
// Build cache data.
if ($cache_write) {
foreach ($queried_entities as $id => $entity) {
$data = array();
$instances = field_info_instances($entity_type, $entity->bundle());
foreach ($instances as $instance) {
$data[$instance['field_name']] = $queried_entities[$id]->{$instance['field_name']};
}
$cid = "field:$entity_type:$id";
cache('field')->set($cid, $data);
}
}
}
}
/**
* Loads all fields for previous versions of a group of entities.
*
* Loading different versions of the same entities is not supported, and should
* be done by separate calls to the function.
*
* field_attach_load_revision() is automatically called by the default entity
* controller class, and thus, in most cases, doesn't need to be explicitly
* called by the entity type module.
*
* @param $entity_type
* The type of entities in $entities; e.g. 'node' or 'user'.
* @param $entities
* An array of entities for which to load fields, keyed by entity ID. Each
* entity needs to have its 'bundle', 'id' and (if applicable) 'revision' keys
* filled. The function adds the loaded field data directly in the entity
* objects of the $entities array.
* @param $options
* An associative array of additional options. See field_attach_load() for
* details.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_load_revision($entity_type, $entities, $options = array()) {
return field_attach_load($entity_type, $entities, FIELD_LOAD_REVISION, $options);
}
/**
* Performs field validation against form-submitted field values.
*
* There are two levels of validation for fields in forms: widget validation and
* 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 entity types should call this function during their own
* form validation function.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity being submitted. The actual field values will be read
* from $form_state['values'].
* @param $form
* The form structure where field elements are attached to. This might be a
* full form structure, or a sub-element of a larger form.
* @param $form_state
* An associative array containing the current state of the form.
* @param array $options
* An associative array of additional options. See field_invoke_method() for
* details.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_form_validate(EntityInterface $entity, $form, &$form_state, array $options = array()) {
// Only support NG entities.
if (!($entity->getNGEntity() instanceof EntityNG)) {
return;
}
$has_violations = FALSE;
foreach ($entity as $field_name => $field) {
$definition = $field->getDefinition();
if (!empty($definition['configurable']) && (empty($options['field_name']) || $options['field_name'] == $field_name)) {
$field_violations = $field->validate();
if (count($field_violations)) {
$has_violations = TRUE;
// Place violations in $form_state.
$langcode = field_is_translatable($entity->entityType(), field_info_field($field_name)) ? $entity->language()->id : Language::LANGCODE_NOT_SPECIFIED;
$field_state = field_form_get_state($form['#parents'], $field_name, $langcode, $form_state);
$field_state['constraint_violations'] = $field_violations;
field_form_set_state($form['#parents'], $field_name, $langcode, $form_state, $field_state);
}
}
}
if ($has_violations) {
// Map errors back to form elements.
field_invoke_method('flagErrors', _field_invoke_widget_target($form_state['form_display']), $entity, $form, $form_state, $options);
}
}
/**
* Populates an entity object with values from a form submission.
*
* Currently, this accounts for drag-and-drop reordering of field values, and
* filtering of empty values.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity being submitted. The actual field values will be read
* from $form_state['values'].
* @param $form
* The form structure where field elements are attached to. This might be a
* full form structure, or a sub-element of a larger form.
* @param $form_state
* An associative array containing the current state of the form.
* @param array $options
* An associative array of additional options. See field_invoke_method() for
* details.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_extract_form_values(EntityInterface $entity, $form, &$form_state, array $options = array()) {
// Ensure we are working with a BC mode entity.
$entity = $entity->getBCEntity();
// Extract field values from submitted values.
$form_display = $form_state['form_display'];
field_invoke_method('extractFormValues', _field_invoke_widget_target($form_display), $entity, $form, $form_state, $options);
// Let other modules act on submitting the entity.
// Avoid \Drupal::moduleHandler()->invokeAll()
// to let $form_state be taken by reference.
foreach (Drupal::moduleHandler()->getImplementations('field_attach_extract_form_values') as $module) {
$function = $module . 'field_attach_extract_form_values';
$function($entity, $form, $form_state);
}
}
/**
* Save field data for a new entity.
*
* The passed-in entity must already contain its id and (if applicable)
* revision id attributes.
* Default values (if any) will be saved for fields not present in the
* $entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity with fields to save.
* @return
* Default values (if any) will be added to the $entity parameter for fields
* it leaves unspecified.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_insert(EntityInterface $entity) {
// Ensure we are working with a BC mode entity.
$entity = $entity->getBCEntity();
// Let any module insert field data before the storage engine, accumulating
// saved fields along the way.
$skip_fields = array();
foreach (Drupal::moduleHandler()->getImplementations('field_storage_pre_insert') as $module) {
$function = $module . '_field_storage_pre_insert';
$function($entity, $skip_fields);
}
// Collect the storage backends used by the remaining fields in the entities.
$storages = array();
foreach (field_info_instances($entity->entityType(), $entity->bundle()) as $instance) {
$field = field_info_field_by_id($instance['field_id']);
$field_id = $field['uuid'];
$field_name = $field['field_name'];
if (!empty($entity->$field_name)) {
// Collect the storage backend if the field has not been written yet.
if (!isset($skip_fields[$field_id])) {
$storages[$field['storage']['type']][$field_id] = $field_id;
}
}
}
// Field storage backends save any remaining unsaved fields.
foreach ($storages as $storage => $fields) {
$storage_info = field_info_storage_types($storage);
module_invoke($storage_info['module'], 'field_storage_write', $entity, FIELD_STORAGE_INSERT, $fields);
}
}
/**
* Saves field data for an existing entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity with fields to save.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_update(EntityInterface $entity) {
// Ensure we are working with a BC mode entity.
$entity = $entity->getBCEntity();
// Let any module update field data before the storage engine, accumulating
// saved fields along the way.
$skip_fields = array();
foreach (Drupal::moduleHandler()->getImplementations('field_storage_pre_update') as $module) {
$function = $module . '_field_storage_pre_update';
$function($entity, $skip_fields);
}
// Collect the storage backends used by the remaining fields in the entities.
$storages = array();
foreach (field_info_instances($entity->entityType(), $entity->bundle()) as $instance) {
$field = field_info_field_by_id($instance['field_id']);
$field_id = $field['uuid'];
// Collect the storage backend if the field has not been written yet.
if (!isset($skip_fields[$field_id])) {
$storages[$field['storage']['type']][$field_id] = $field_id;
}
}
// Field storage backends save any remaining unsaved fields.
foreach ($storages as $storage => $fields) {
$storage_info = field_info_storage_types($storage);
module_invoke($storage_info['module'], 'field_storage_write', $entity, FIELD_STORAGE_UPDATE, $fields);
}
$entity_info = $entity->entityInfo();
if ($entity_info['field_cache']) {
cache('field')->delete('field:' . $entity->entityType() . ':' . $entity->id());
}
}
/**
* Deletes field data for an existing entity. This deletes all revisions of
* field data for the entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity whose field data to delete.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_delete(EntityInterface $entity) {
// Ensure we are working with a BC mode entity.
$entity = $entity->getBCEntity();
// Collect the storage backends used by the fields in the entities.
$storages = array();
foreach (field_info_instances($entity->entityType(), $entity->bundle()) as $instance) {
$field = field_info_field_by_id($instance['field_id']);
$field_id = $field['uuid'];
$storages[$field['storage']['type']][$field_id] = $field_id;
}
// Field storage backends delete their data.
foreach ($storages as $storage => $fields) {
$storage_info = field_info_storage_types($storage);
module_invoke($storage_info['module'], 'field_storage_delete', $entity, $fields);
}
$entity_info = $entity->entityInfo();
if ($entity_info['field_cache']) {
cache('field')->delete('field:' . $entity->entityType() . ':' . $entity->id());
}
}
/**
* Delete field data for a single revision of an existing entity. The passed
* entity must have a revision ID attribute.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity with fields to save.
*
* @deprecated as of Drupal 8.0. Use the entity system instead.
*/
function field_attach_delete_revision(EntityInterface $entity) {
// Ensure we are working with a BC mode entity.
$entity = $entity->getBCEntity();
// Collect the storage backends used by the fields in the entities.
$storages = array();
foreach (field_info_instances($entity->entityType(), $entity->bundle()) as $instance) {
$field = field_info_field_by_id($instance['field_id']);
$field_id = $field['uuid'];
$storages[$field['storage']['type']][$field_id] = $field_id;
}
// Field storage backends delete their data.
foreach ($storages as $storage => $fields) {
$storage_info = field_info_storage_types($storage);
module_invoke($storage_info['module'], 'field_storage_delete_revision', $entity, $fields);
}
}
/**
* Prepares field data prior to display.
*
* This function lets field types and formatters load additional data needed for
* display that is not automatically loaded during field_attach_load(). It
* accepts an array of entities to allow query optimization when displaying
* lists of entities.
*