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

7
use Drupal\Core\Config\ConfigImporter;
8
use Drupal\Core\Entity\EntityTypeInterface;
9
use Drupal\Core\Entity\DynamicallyFieldableEntityStorageInterface;
10
use Drupal\field\ConfigImporterFieldPurger;
11
use Drupal\field\Entity\FieldConfig;
12 13 14
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\field\FieldConfigInterface;
use Drupal\field\FieldStorageConfigInterface;
15
use Drupal\Core\Form\FormStateInterface;
16
use Drupal\Core\Routing\RouteMatchInterface;
17
use Drupal\Core\Url;
18

19
/*
20 21 22
 * 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.
23
 */
24
require_once __DIR__ . '/field.purge.inc';
25

26 27 28
/**
 * @defgroup field Field API
 * @{
29 30 31 32 33 34 35 36
 * 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.
37
 *
38 39 40
 * The Field API defines two primary data structures, FieldStorage and Field,
 * and the concept of a Bundle. A FieldStorage defines a particular type of data
 * that can be attached to entities. A Field is attached to a single
41 42 43 44 45 46 47 48 49
 * 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
50
 * node storage loads an Article node, it loads the values of the
51 52
 * 'subtitle' and 'photo' fields because they are both attached to the 'node'
 * bundle 'article'.
53
 *
54 55 56 57 58 59
 * - @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_purge Field API bulk data deletion @endlink: Cleans up after
60
 *   bulk deletion operations such as deletion of field storage or field.
61 62 63
 */

/**
64
 * Implements hook_help().
65
 */
66
function field_help($route_name, RouteMatchInterface $route_match) {
67 68
  switch ($route_name) {
    case 'help.page.field':
69
      $field_ui_url = \Drupal::moduleHandler()->moduleExists('field_ui') ? \Drupal::url('help.page', array('name' => 'field_ui')) : '#';
70 71
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
72
      $output .= '<p>' . t('The Field module allows custom data fields to be defined for <em>entity</em> types (see below). 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 <a href=":field">online documentation for the Field module</a>.', array(':field-ui-help' => $field_ui_url, ':field' => 'https://www.drupal.org/documentation/modules/field')). '</p>';
73 74 75 76 77 78 79 80 81 82 83 84 85
      $output .= '<h3>' . t('Terminology') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Entities and entity types') . '</dt>';
      $output .= '<dd>' . t('The website\'s content and configuration is managed using <em>entities</em>, which are grouped into <em>entity types</em>. <em>Content entity types</em> are the entity types for site content (such as the main site content, comments, custom blocks, taxonomy terms, and user accounts). <em>Configuration entity types</em> are used to store configuration information for your site, such as individual views in the Views module, and settings for your main site content types.') . '</dd>';
      $output .= '<dt>' . t('Entity sub-types') . '</dt>';
      $output .= '<dd>' . t('Some content entity types are further grouped into sub-types (for example, you could have article and page content types within the main site content entity type, and tag and category vocabularies within the taxonomy term entity type); other entity types, such as user accounts, do not have sub-types. Programmers use the term <em>bundle</em> for entity sub-types.') . '</dd>';
      $output .= '<dt>' . t('Fields and field types') . '</dt>';
      $output .= '<dd>' . t('Content entity types and sub-types store most of their text, file, and other information in <em>fields</em>. Fields are grouped by <em>field type</em>; field types define what type of data can be stored in that field, such as text, images, or taxonomy term references.') . '</dd>';
      $output .= '<dt>' . t('Formatters and view modes') . '</dd>';
      $output .= '<dd>' . t('Content entity types and sub-types can have one or more <em>view modes</em>, used for displaying the entity items. For instance, a content item could be viewed in full content mode on its own page, teaser mode in a list, or RSS mode in a feed. In each view mode, each field can be hidden or displayed, and if it is displayed, you can choose and configure the <em>formatter</em> that is used to display the field. For instance, a long text field can be displayed trimmed or full-length, and taxonomy term reference fields can be displayed in plain text or linked to the taxonomy term page.') . '</dd>';
      $output .= '<dt>' . t('Widgets and form modes') . '</dd>';
      $output .= '<dd>' . t('Content entity types and sub-types can have one or more <em>form modes</em>, used for editing. For instance, a content item could be edited in a compact format with only some fields editable, or a full format that allows all fields to be edited. In each form mode, each field can be hidden or displayed, and if it is displayed, you can choose and configure the <em>widget</em> that is used to edit the field. For instance, a taxonomy term reference field can be edited using a select list, radio buttons, or an autocomplete widget.') . '</dd>';
      $output .= '</dl>';
86 87
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
88
      $output .= '<dt>' . t('Enabling field types, widgets, and formatters') . '</dt>';
89
      $output .= '<dd>' . t('The Field module provides the infrastructure for fields; the field types, formatters, and widgets are provided by Drupal core or additional modules. Some of the modules are required; the optional modules can be enabled from the <a href=":modules">Extend administration page</a>. Additional fields, formatters, 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' => \Drupal::url('system.modules_list'), ':contrib' => 'https://www.drupal.org/project/modules')) . '</dd>';
90 91

      $output .= '<h3>' . t('Field, widget, and formatter information') . '</h3>';
92

93 94 95
      // Make a list of all widget, formatter, and field modules currently
      // enabled, ordered by displayed module name (module names are not
      // translated).
96
      $items = array();
97
      $modules = \Drupal::moduleHandler()->getModuleList();
98
      $widgets = \Drupal::service('plugin.manager.field.widget')->getDefinitions();
99
      $field_types = \Drupal::service('plugin.manager.field.field_type')->getUiDefinitions();
100
      $formatters = \Drupal::service('plugin.manager.field.formatter')->getDefinitions();
101
      $providers = array();
102
      foreach (array_merge($field_types, $widgets, $formatters) as $plugin) {
103
        $providers[] = $plugin['provider'];
104
      }
105 106 107 108 109
      $providers = array_unique($providers);
      sort($providers);
      foreach ($providers as $provider) {
        // Skip plugins provided by core components as they do not implement
        // hook_help().
110 111
        if (isset($modules[$provider])) {
          $display = \Drupal::moduleHandler()->getName($provider);
112
          if (\Drupal::moduleHandler()->implementsHook($provider, 'help')) {
113
            $items[] = \Drupal::l($display, new Url('help.page', array('name' => $provider)));
114 115 116 117
          }
          else {
            $items[] = $display;
          }
118 119
        }
      }
120
      if ($items) {
121 122
        $output .= '<dt>' . t('Provided by modules') . '</dt>';
        $output .= '<dd>' . t('Here is a list of the currently enabled field, formatter, and widget modules:');
123 124 125 126
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $items,
        );
127
        $output .= \Drupal::service('renderer')->renderPlain($item_list);
128
        $output .= '</dd>';
129
      }
130 131 132 133

      $output .= '<dt>' . t('Provided by Drupal core') . '</dt>';
      $output .= '<dd>' . t('As mentioned previously, some field types, widgets, and formatters are provided by Drupal core. Here are some notes on how to use some of these:');
      $output .= '<ul>';
134 135 136
      $output .= '<li><p>' . t('<strong>Entity Reference</strong> fields allow you to create fields that contain links to other entities (such as content items, taxonomy terms, etc.) within the site. This allows you, for example, to include a link to a user within a content item. For more information, see <a href=":er_do">the online documentation for the Entity Reference module</a>.', array(':er_do' => 'https://drupal.org/documentation/modules/entityreference')) . '</p>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Managing and displaying entity reference fields') . '</dt>';
137
      $output .= '<dd>' . t('The <em>settings</em> and the <em>display</em> of the entity reference field can be configured separately. See the <a href=":field_ui">Field UI help</a> for more information on how to manage fields and their display.', array(':field_ui' => $field_ui_url)) . '</dd>';
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
      $output .= '<dt>' . t('Selecting reference type') . '</dt>';
      $output .= '<dd>' . t('In the field settings you can select which entity type you want to create a reference to.') . '</dd>';
      $output .= '<dt>' . t('Filtering and sorting reference fields') . '</dt>';
      $output .= '<dd>' . t('Depending on the chosen entity type, additional filtering and sorting options are available for the list of entities that can be referred to, in the field settings. For example, the list of users can be filtered by role and sorted by name or ID.') . '</dd>';
      $output .= '<dt>' . t('Displaying a reference') . '</dt>';
      $output .= '<dd>' . t('An entity reference can be displayed as a simple label with or without a link to the entity. Alternatively, the referenced entity can be displayed as a teaser (or any other available view mode) inside the referencing entity.') . '</dd>';
      $output .= '<dt>' . t('Configuring form displays') . '</dt>';
      $output .= '<dd>' . t('Reference fields have several widgets available on the <em>Manage form display</em> page:');
      $output .= '<ul>';
      $output .= '<li>' . t('The <em>Check boxes/radio buttons</em> widget displays the existing entities for the entity type as check boxes or radio buttons based on the <em>Allowed number of values</em> set for the field.') . '</li>';
      $output .= '<li>' . t('The <em>Select list</em> widget displays the existing entities in a drop-down list or scrolling list box based on the <em>Allowed number of values</em> setting for the field.') . '</li>';
      $output .= '<li>' . t('The <em>Autocomplete</em> widget displays text fields in which users can type entity labels based on the <em>Allowed number of values</em>. The widget can be configured to display all entities that contain the typed characters or restricted to those starting with those characters.') . '</li>';
      $output .= '<li>' . t('The <em>Autocomplete (Tags style)</em> widget displays a multi-text field in which users can type in a comma-separated list of entity labels.') . '</li>';
      $output .= '</ul></dd>';
      $output .= '</dl></li>';
153 154 155
      $output .= '<li>' . t('<strong>Number fields</strong>: When you add a number field you can choose from three types: <em>decimal</em>, <em>float</em>, and <em>integer</em>. The <em>decimal</em> number field type allows users to enter exact decimal values, with fixed numbers of decimal places. The <em>float</em> number field type allows users to enter approximate decimal values. The <em>integer</em> number field type allows users to enter whole numbers, such as years (for example, 2012) or values (for example, 1, 2, 5, 305). It does not allow decimals.') . '</li>';
      $output .= '</ul></dd>';
      $output .= '</dl>';
156 157 158 159
      return $output;
  }
}

160
/**
161
 * Implements hook_cron().
162 163
 */
function field_cron() {
164
  // Do a pass of purging on deleted Field API data, if any exists.
165
  $limit = \Drupal::config('field.settings')->get('purge_batch_size');
166 167 168
  field_purge_batch($limit);
}

169 170 171
/**
 * Implements hook_entity_field_storage_info().
 */
172
function field_entity_field_storage_info(EntityTypeInterface $entity_type) {
173
  if (\Drupal::entityManager()->getStorage($entity_type->id()) instanceof DynamicallyFieldableEntityStorageInterface) {
174 175
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
176
    $ids = \Drupal::entityQuery('field_storage_config')
177 178 179
      ->condition('id', $entity_type->id() . '.', 'STARTS_WITH')
      ->execute();
    // Fetch all fields and key them by field name.
180
    $field_storages = FieldStorageConfig::loadMultiple($ids);
181
    $result = array();
182 183
    foreach ($field_storages as $field_storage) {
      $result[$field_storage->getName()] = $field_storage;
184
    }
185

186 187 188 189
    return $result;
  }
}

190
/**
191
 * Implements hook_entity_bundle_field_info().
192
 */
193
function field_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
194
  if (\Drupal::entityManager()->getStorage($entity_type->id()) instanceof DynamicallyFieldableEntityStorageInterface) {
195 196
    // Query by filtering on the ID as this is more efficient than filtering
    // on the entity_type property directly.
197
    $ids = \Drupal::entityQuery('field_config')
198 199 200
      ->condition('id', $entity_type->id() . '.' . $bundle . '.', 'STARTS_WITH')
      ->execute();
    // Fetch all fields and key them by field name.
201
    $field_configs = FieldConfig::loadMultiple($ids);
202
    $result = array();
203 204
    foreach ($field_configs as $field_instance) {
      $result[$field_instance->getName()] = $field_instance;
205
    }
206

207
    return $result;
208 209 210
  }
}

211 212 213
/**
 * Implements hook_entity_bundle_delete().
 */
214 215
function field_entity_bundle_delete($entity_type_id, $bundle) {
  $storage = \Drupal::entityManager()->getStorage('field_config');
216
  // Get the fields on the bundle.
217
  $fields = $storage->loadByProperties(['entity_type' => $entity_type_id, 'bundle' => $bundle]);
218 219 220 221 222 223
  // This deletes the data for the field as well as the field themselves. This
  // function actually just marks the data and fields 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).
224 225
  foreach ($fields as $field) {
    $field->delete();
226
  }
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

  // We are duplicating the work done by
  // \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem::onDependencyRemoval()
  // because we need to take into account bundles that are not provided by a
  // config entity type so they are not part of the config dependencies.

  // Gather a list of all entity reference fields.
  $map = \Drupal::entityManager()->getFieldMapByFieldType('entity_reference');
  $ids = [];
  foreach ($map as $type => $info) {
    foreach ($info as $name => $data) {
      foreach ($data['bundles'] as $bundle_name) {
        $ids[] = "$type.$bundle_name.$name";
      }
    }
  }

  // Update the 'target_bundles' handler setting if needed.
  foreach (FieldConfig::loadMultiple($ids) as $field_config) {
    if ($field_config->getSetting('target_type') == $entity_type_id) {
      $handler_settings = $field_config->getSetting('handler_settings');
      if (isset($handler_settings['target_bundles'][$bundle])) {
        unset($handler_settings['target_bundles'][$bundle]);
        $field_config->setSetting('handler_settings', $handler_settings);
        $field_config->save();

        // In case we deleted the only target bundle allowed by the field we
254
        // have to log a critical message because the field will not function
255 256 257 258 259 260 261 262 263 264 265 266 267
        // correctly anymore.
        if ($handler_settings['target_bundles'] === []) {
          \Drupal::logger('entity_reference')->critical('The %target_bundle bundle (entity type: %target_entity_type) was deleted. As a result, the %field_name entity reference field (entity_type: %entity_type, bundle: %bundle) no longer has any valid bundle it can reference. The field is not working correctly anymore and has to be adjusted.', [
            '%target_bundle' => $bundle,
            '%target_entity_type' => $entity_type_id,
            '%field_name' => $field_config->getName(),
            '%entity_type' => $field_config->getTargetEntityTypeId(),
            '%bundle' => $field_config->getTargetBundle()
          ]);
        }
      }
    }
  }
268 269 270
}

/**
271
 * @} End of "defgroup field".
272
 */
273

274 275 276
/**
 * Assembles a partial entity structure with initial IDs.
 *
277
 * @param object $ids
278 279 280
 *   An object with the properties entity_type (required), entity_id (required),
 *   revision_id (optional) and bundle (optional).
 *
281
 * @return \Drupal\Core\Entity\EntityInterface
282 283 284 285
 *   An entity, initialized with the provided IDs.
 */
function _field_create_entity_from_ids($ids) {
  $id_properties = array();
286 287
  $entity_type = \Drupal::entityManager()->getDefinition($ids->entity_type);
  if ($id_key = $entity_type->getKey('id')) {
288
    $id_properties[$id_key] = $ids->entity_id;
289
  }
290
  if (isset($ids->revision_id) && $revision_key = $entity_type->getKey('revision')) {
291
    $id_properties[$revision_key] = $ids->revision_id;
292
  }
293
  if (isset($ids->bundle) && $bundle_key = $entity_type->getKey('bundle')) {
294
    $id_properties[$bundle_key] = $ids->bundle;
295
  }
296 297 298
  return \Drupal::entityTypeManager()
    ->getStorage($ids->entity_type)
    ->create($id_properties);
299 300
}

301 302 303 304
/**
 * Implements hook_config_import_steps_alter().
 */
function field_config_import_steps_alter(&$sync_steps, ConfigImporter $config_importer) {
305
  $field_storages = ConfigImporterFieldPurger::getFieldStoragesToPurge(
306 307 308
    $config_importer->getStorageComparer()->getSourceStorage()->read('core.extension'),
    $config_importer->getStorageComparer()->getChangelist('delete')
  );
309
  if ($field_storages) {
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
    // Add a step to the beginning of the configuration synchronization process
    // to purge field data where the module that provides the field is being
    // uninstalled.
    array_unshift($sync_steps, array('\Drupal\field\ConfigImporterFieldPurger', 'process'));
  };
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Adds a warning if field data will be permanently removed by the configuration
 * synchronization.
 *
 * @see \Drupal\field\ConfigImporterFieldPurger
 */
325
function field_form_config_admin_import_form_alter(&$form, FormStateInterface $form_state) {
326 327
  // Only display the message when there is a storage comparer available and the
  // form is not submitted.
328
  $user_input = $form_state->getUserInput();
329 330
  $storage_comparer = $form_state->get('storage_comparer');
  if ($storage_comparer && empty($user_input)) {
331
    $field_storages = ConfigImporterFieldPurger::getFieldStoragesToPurge(
332 333
      $storage_comparer->getSourceStorage()->read('core.extension'),
      $storage_comparer->getChangelist('delete')
334
    );
335 336
    if ($field_storages) {
      foreach ($field_storages as $field) {
337 338 339
        $field_labels[] = $field->label();
      }
      drupal_set_message(\Drupal::translation()->formatPlural(
340
        count($field_storages),
341 342 343 344 345 346 347
        'This synchronization will delete data from the field %fields.',
        'This synchronization will delete data from the fields: %fields.',
        array('%fields' => implode(', ', $field_labels))
      ), 'warning');
    }
  }
}
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

/**
 * Implements hook_ENTITY_TYPE_update() for 'field_storage_config'.
 *
 * Reset the field handler settings, when the storage target_type is changed on
 * an entity reference field.
 */
function field_field_storage_config_update(FieldStorageConfigInterface $field_storage) {
  if ($field_storage->isSyncing()) {
    // Don't change anything during a configuration sync.
    return;
  }

  // Act on all sub-types of the entity_reference field type.
  /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */
  $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
  $item_class = 'Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem';
  $class = $field_type_manager->getPluginClass($field_storage->getType());
  if ($class !== $item_class && !is_subclass_of($class, $item_class)) {
    return;
  }

  // If target_type changed, reset the handler in the fields using that storage.
  if ($field_storage->getSetting('target_type') !== $field_storage->original->getSetting('target_type')) {
    foreach ($field_storage->getBundles() as $bundle) {
      $field = FieldConfig::loadByName($field_storage->getTargetEntityTypeId(), $bundle, $field_storage->getName());
      // Reset the handler settings. This triggers field_field_config_presave(),
      // which will take care of reassigning the handler to the correct
      // derivative for the new target_type.
      $field->setSetting('handler_settings', []);
      $field->save();
    }
  }
}

/**
 * Implements hook_ENTITY_TYPE_presave() for 'field_config'.
 *
 * Determine the selection handler plugin ID for an entity reference field.
 */
function field_field_config_presave(FieldConfigInterface $field) {
  // Don't change anything during a configuration sync.
  if ($field->isSyncing()) {
    return;
  }

  // Act on all sub-types of the entity_reference field type.
  /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */
  $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
  $item_class = 'Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem';
  $class = $field_type_manager->getPluginClass($field->getType());
  if ($class !== $item_class && !is_subclass_of($class, $item_class)) {
    return;
  }

  // Make sure the selection handler plugin is the correct derivative for the
  // target entity type.
  $target_type = $field->getFieldStorageDefinition()->getSetting('target_type');
  $selection_manager = \Drupal::service('plugin.manager.entity_reference_selection');
  list($current_handler) = explode(':', $field->getSetting('handler'), 2);
  $field->setSetting('handler', $selection_manager->getPluginId($target_type, $current_handler));
}