field.module 13.8 KB
Newer Older
1 2 3
<?php
/**
 * @file
4
 * Attach custom data fields to Drupal entities.
5 6
 */

7 8
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\Xss;
9
use Drupal\Core\Entity\EntityTypeInterface;
10
use Drupal\Core\Extension\Extension;
11
use Drupal\field\Field;
12

13
/*
14 15 16
 * Load all public Field API functions. Drupal currently has no
 * mechanism for auto-loading core APIs, so we have to load them on
 * every page request.
17
 */
18 19
require_once __DIR__ . '/field.info.inc';
require_once __DIR__ . '/field.form.inc';
20 21
require_once __DIR__ . '/field.purge.inc';
require_once __DIR__ . '/field.deprecated.inc';
22

23 24 25
/**
 * @defgroup field Field API
 * @{
26 27 28 29 30 31 32 33
 * Attaches custom data fields to Drupal entities.
 *
 * The Field API allows custom data fields to be attached to Drupal entities and
 * takes care of storing, loading, editing, and rendering field data. Any entity
 * type (node, user, etc.) can use the Field API to make itself "fieldable" and
 * thus allow fields to be attached to it. Other modules can provide a user
 * interface for managing custom fields via a web browser as well as a wide and
 * flexible variety of data type, form element, and display format capabilities.
34
 *
35 36 37 38 39 40 41 42 43 44 45 46
 * The Field API defines two primary data structures, Field and Instance, and
 * the concept of a Bundle. A Field defines a particular type of data that can
 * be attached to entities. A Field Instance is a Field attached to a single
 * Bundle. A Bundle is a set of fields that are treated as a group by the Field
 * Attach API and is related to a single fieldable entity type.
 *
 * For example, suppose a site administrator wants Article nodes to have a
 * subtitle and photo. Using the Field API or Field UI module, the administrator
 * creates a field named 'subtitle' of type 'text' and a field named 'photo' of
 * type 'image'. The administrator (again, via a UI) creates two Field
 * Instances, one attaching the field 'subtitle' to the 'node' bundle 'article'
 * and one attaching the field 'photo' to the 'node' bundle 'article'. When the
47
 * node storage loads an Article node, it loads the values of the
48 49
 * 'subtitle' and 'photo' fields because they are both attached to the 'node'
 * bundle 'article'.
50
 *
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
 * - @link field_types Field Types API @endlink: Defines field types, widget
 *   types, and display formatters. Field modules use this API to provide field
 *   types like Text and Node Reference along with the associated form elements
 *   and display formatters.
 *
 * - @link field_crud Field CRUD API @endlink: Create, updates, and deletes
 *   fields, bundles (a.k.a. "content types"), and instances. Modules use this
 *   API, often in hook_install(), to create custom data structures.
 *
 * - @link field_attach Field Attach API @endlink: Connects entity types to the
 *   Field API. Field Attach API functions load, store, generate Form API
 *   structures, display, and perform a variety of other functions for field
 *   data connected to individual entities. Fieldable entity types like node and
 *   user use this API to make themselves fieldable.
 *
 * - @link field_info Field Info API @endlink: Exposes information about all
 *   fields, instances, widgets, and related information defined by or with the
 *   Field API.
 *
 * - @link field_purge Field API bulk data deletion @endlink: Cleans up after
71
 *   bulk deletion operations such as deletion of field or field_instance.
72 73
 *
 * - @link field_language Field language API @endlink: Provides native
74
 *   multilingual support for the Field API.
75 76 77
 */

/**
78
 * Implements hook_help().
79 80 81 82
 */
function field_help($path, $arg) {
  switch ($path) {
    case 'admin/help#field':
83 84
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
85
      $output .= '<p>' . t('The Field module allows custom data fields to be defined for <em>entity</em> types (entities include content items, comments, user accounts, and taxonomy terms). The Field module takes care of storing, loading, editing, and rendering field data. Most users will not interact with the Field module directly, but will instead use the <a href="@field-ui-help">Field UI module</a> user interface. Module developers can use the Field API to make new entity types "fieldable" and thus allow fields to be attached to them. For more information, see the online handbook entry for <a href="@field">Field module</a>.', array('@field-ui-help' => url('admin/help/field_ui'), '@field' => 'http://drupal.org/documentation/modules/field')) . '</p>';
86 87 88
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling field types') . '</dt>';
89
      $output .= '<dd>' . t('The Field module provides the infrastructure for fields and field attachment; the field types and input widgets themselves are provided by additional modules. The modules can be enabled from the <a href="@modules">Modules administration page</a>. Drupal core includes the following field type modules: Text, Number, Email, Link, Telephone, Image, File, Options, Taxonomy, and Entity Reference. Additional fields and widgets may be provided by contributed modules, which you can find in the <a href="@contrib">contributed module section of Drupal.org</a>.', array('@modules' => url('admin/modules'), '@contrib' => 'http://drupal.org/project/modules', '@options' => url('admin/help/options')));
90

91 92
      // Make a list of all widget and field modules currently enabled, ordered
      // by displayed module name (module names are not translated).
93 94
      $items = array();
      $info = system_get_info('module');
95
      $field_widgets = \Drupal::service('plugin.manager.field.widget')->getDefinitions();
96
      $field_types = \Drupal::service('plugin.manager.field.field_type')->getUiDefinitions();
97
      $providers = array();
98 99
      foreach (array_merge($field_types, $field_widgets) as $plugin) {
        $providers[] = $plugin['provider'];
100
      }
101 102 103 104 105 106 107 108 109 110 111 112 113
      $providers = array_unique($providers);
      sort($providers);
      foreach ($providers as $provider) {
        // Skip plugins provided by core components as they do not implement
        // hook_help().
        if (isset($info[$provider]['name'])) {
          $display = $info[$provider]['name'];
          if (\Drupal::moduleHandler()->implementsHook($provider, 'help')) {
            $items[] = l($display, 'admin/help/' . $provider);
          }
          else {
            $items[] = $display;
          }
114 115
        }
      }
116 117 118 119 120 121 122 123
      if ($items) {
        $output .= ' ' . t('Currently enabled field and input widget modules:');
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $items,
        );
        $output .= drupal_render($item_list);
      }
124 125 126 127
      return $output;
  }
}

128
/**
129
 * Implements hook_cron().
130 131
 */
function field_cron() {
132
  // Do a pass of purging on deleted Field API data, if any exists.
133
  $limit = \Drupal::config('field.settings')->get('purge_batch_size');
134 135 136
  field_purge_batch($limit);
}

137
/**
138 139
 * Implements hook_system_info_alter().
 *
140
 * Goes through a list of all modules that provide a field type and makes them
141
 * required if there are any active fields of that type.
142
 */
143
function field_system_info_alter(&$info, Extension $file, $type) {
144 145
  // It is not safe to call entity_load_multiple_by_properties() during
  // maintenance mode.
146
  if ($type == 'module' && !defined('MAINTENANCE_MODE')) {
147
    $fields = entity_load_multiple_by_properties('field_config', array('module' => $file->getName(), 'include_deleted' => TRUE));
148 149 150 151 152 153 154
    if ($fields) {
      $info['required'] = TRUE;

      // Provide an explanation message (only mention pending deletions if there
      // remains no actual, non-deleted fields)
      $non_deleted = FALSE;
      foreach ($fields as $field) {
155
        if (empty($field->deleted)) {
156 157 158 159 160
          $non_deleted = TRUE;
          break;
        }
      }
      if ($non_deleted) {
161
        if (\Drupal::moduleHandler()->moduleExists('field_ui')) {
162
          $explanation = t('Field type(s) in use - see <a href="@fields-page">Field list</a>', array('@fields-page' => url('admin/reports/fields')));
163 164 165 166 167 168 169 170 171 172
        }
        else {
          $explanation = t('Fields type(s) in use');
        }
      }
      else {
        $explanation = t('Fields pending deletion');
      }
      $info['explanation'] = $explanation;
    }
173 174 175
  }
}

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
/**
 * Implements hook_entity_field_storage_info().
 */
function field_entity_field_storage_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type) {
  // Expose storage definitions for all exposed bundle fields.
  if ($entity_type->isFieldable()) {
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
    $ids = \Drupal::entityQuery('field_config')
      ->condition('id', $entity_type->id() . '.', 'STARTS_WITH')
      ->execute();

    // Fetch all fields and key them by field name.
    $field_configs = entity_load_multiple('field_config', $ids);
    $result = array();
    foreach ($field_configs as $field_config) {
      $result[$field_config->getName()] = $field_config;
    }
    return $result;
  }
}

198
/**
199
 * Implements hook_entity_bundle_field_info().
200
 */
201 202 203 204 205
function field_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
  if ($entity_type->isFieldable()) {
    // Configurable fields, which are always attached to a specific bundle, are
    // added 'by bundle'.
    return Field::fieldInfo()->getBundleInstances($entity_type->id(), $bundle);
206 207 208
  }
}

209
/**
210
 * Implements hook_entity_bundle_create().
211
 */
212 213 214 215
function field_entity_bundle_create($entity_type, $bundle) {
  // Clear the cache.
  field_cache_clear();
}
216

217 218 219 220
/**
 * Implements hook_entity_bundle_rename().
 */
function field_entity_bundle_rename($entity_type, $bundle_old, $bundle_new) {
221
  $instances = entity_load_multiple_by_properties('field_instance_config', array('entity_type' => $entity_type, 'bundle' => $bundle_old));
222 223
  foreach ($instances as $instance) {
    if ($instance->entity_type == $entity_type && $instance->bundle == $bundle_old) {
224
      $id_new = $instance->entity_type . '.' . $bundle_new . '.' . $instance->field_name;
225
      $instance->set('id', $id_new);
226 227 228
      $instance->bundle = $bundle_new;
      $instance->allowBundleRename();
      $instance->save();
229 230
    }
  }
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

  // Clear the field cache.
  field_cache_clear();
}

/**
 * Implements hook_entity_bundle_delete().
 *
 * 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 as
 * 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).
 */
function field_entity_bundle_delete($entity_type, $bundle) {
247 248 249
  // Get the instances on the bundle. entity_load_multiple_by_properties() must
  // be used here since field_info_instances() does not return instances for
  // disabled entity types or bundles.
250
  $instances = entity_load_multiple_by_properties('field_instance_config', array('entity_type' => $entity_type, 'bundle' => $bundle));
251 252 253 254 255 256
  foreach ($instances as $instance) {
    $instance->delete();
  }

  // Clear the cache.
  field_cache_clear();
257 258
}

259 260 261 262
/**
 * Implements hook_rebuild().
 */
function field_rebuild() {
263
  field_cache_clear();
264 265
}

266
/**
267
 * Implements hook_modules_installed().
268
 */
269
function field_modules_installed($modules) {
270
  field_cache_clear();
271 272 273
}

/**
274
 * Implements hook_modules_uninstalled().
275
 */
276
function field_modules_uninstalled($modules) {
277
  field_cache_clear();
278 279 280
}

/**
281
 * Clears the field info and field data caches.
282
 */
283
function field_cache_clear() {
284
  \Drupal::cache('entity')->deleteAll();
285
  field_info_cache_clear();
286 287 288
}

/**
289 290
 * Filters an HTML string to prevent cross-site-scripting (XSS) vulnerabilities.
 *
291 292
 * Like \Drupal\Component\Utility\Xss::filterAdmin(), but with a shorter list
 * of allowed tags.
293
 *
294 295 296 297 298 299 300 301 302 303
 * Used for items entered by administrators, like field descriptions, allowed
 * values, where some (mainly inline) mark-up may be desired (so
 * drupal_htmlspecialchars() is not acceptable).
 *
 * @param $string
 *   The string with raw HTML in it.
 *
 * @return
 *   An XSS safe version of $string, or an empty string if $string is not valid
 *   UTF-8.
304 305
 */
function field_filter_xss($string) {
306
  return Html::normalize(Xss::filter($string, _field_filter_xss_allowed_tags()));
307 308 309
}

/**
310
 * Returns a list of tags allowed by field_filter_xss().
311 312 313 314 315 316
 */
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');
}

/**
317
 * Returns a human-readable list of allowed tags for display in help texts.
318 319 320 321 322 323
 */
function _field_filter_xss_display_allowed_tags() {
  return '<' . implode('> <', _field_filter_xss_allowed_tags()) . '>';
}

/**
324
 * @} End of "defgroup field".
325
 */
326

327 328 329
/**
 * Assembles a partial entity structure with initial IDs.
 *
330
 * @param object $ids
331 332 333
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
334
 * @return \Drupal\Core\Entity\EntityInterface
335 336 337 338
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
339 340
  $entity_type = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $entity_type->getKey('id')) {
341
    $id_properties[$id_key] = $ids->entity_id;
342
  }
343
  if (isset($ids->revision_id) && $revision_key = $entity_type->getKey('revision')) {
344
    $id_properties[$revision_key] = $ids->revision_id;
345
  }
346
  if (isset($ids->bundle) && $bundle_key = $entity_type->getKey('bundle')) {
347
    $id_properties[$bundle_key] = $ids->bundle;
348 349
  }
  return entity_create($ids->entity_type, $id_properties);
350 351
}

352 353 354 355 356 357 358 359 360 361 362 363 364
/**
 * Implements hook_hook_info().
 */
function field_hook_info() {
  $hooks['field_views_data'] = array(
    'group' => 'views',
  );
  $hooks['field_views_data_alter'] = array(
    'group' => 'views',
  );

  return $hooks;
}