common.inc 46.3 KB
Newer Older
Dries's avatar
 
Dries committed
1 2
<?php

3 4 5 6 7 8 9 10
/**
 * @file
 * Common functions that many Drupal modules will need to reference.
 *
 * The functions that are critical and need to be available even when serving
 * a cached page are instead located in bootstrap.inc.
 */

11
use Drupal\Component\Serialization\Json;
12 13
use Drupal\Component\Serialization\Yaml;
use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
14
use Drupal\Component\Utility\Bytes;
15
use Drupal\Component\Utility\Crypt;
16
use Drupal\Component\Utility\Html;
17
use Drupal\Component\Utility\Number;
18
use Drupal\Component\Utility\SortArray;
19
use Drupal\Component\Utility\SafeMarkup;
20
use Drupal\Component\Utility\Tags;
21
use Drupal\Component\Utility\UrlHelper;
22
use Drupal\Core\Asset\AttachedAssets;
23
use Drupal\Core\Cache\Cache;
24
use Drupal\Core\Language\LanguageInterface;
25
use Drupal\Core\Render\SafeString;
26
use Drupal\Core\Render\Renderer;
27
use Drupal\Core\Site\Settings;
28
use Drupal\Core\Url;
29 30
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
31
use Drupal\Core\PhpStorage\PhpStorageFactory;
32
use Drupal\Component\Utility\NestedArray;
33
use Drupal\Core\Datetime\DrupalDateTime;
34
use Drupal\Core\Routing\GeneratorNotInitializedException;
35
use Drupal\Core\Template\Attribute;
36
use Drupal\Core\Render\BubbleableMetadata;
37
use Drupal\Core\Render\Element;
38
use Drupal\Core\Session\AnonymousUserSession;
39

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
/**
 * @defgroup php_wrappers PHP wrapper functions
 * @{
 * Functions that are wrappers or custom implementations of PHP functions.
 *
 * Certain PHP functions should not be used in Drupal. Instead, Drupal's
 * replacement functions should be used.
 *
 * For example, for improved or more secure UTF8-handling, or RFC-compliant
 * handling of URLs in Drupal.
 *
 * For ease of use and memorizing, all these wrapper functions use the same name
 * as the original PHP function, but prefixed with "drupal_". Beware, however,
 * that not all wrapper functions support the same arguments as the original
 * functions.
 *
 * You should always use these wrapper functions in your code.
 *
 * Wrong:
 * @code
 *   $my_substring = substr($original_string, 0, 5);
 * @endcode
 *
 * Correct:
 * @code
65
 *   $my_substring = Unicode::substr($original_string, 0, 5);
66 67
 * @endcode
 *
68
 * @}
69 70
 */

71 72 73
/**
 * Return status for saving which involved creating a new item.
 */
74
const SAVED_NEW = 1;
75 76 77 78

/**
 * Return status for saving which involved an update to an existing item.
 */
79
const SAVED_UPDATED = 2;
80 81 82 83

/**
 * Return status for saving which deleted an existing item.
 */
84
const SAVED_DELETED = 3;
85

86
/**
87
 * The default aggregation group for CSS files added to the page.
88
 */
89
const CSS_AGGREGATE_DEFAULT = 0;
90 91

/**
92
 * The default aggregation group for theme CSS files added to the page.
93
 */
94 95 96 97 98 99 100 101 102 103 104 105 106
const CSS_AGGREGATE_THEME = 100;

/**
 * The default weight for CSS rules that style HTML elements ("base" styles).
 */
const CSS_BASE = -200;

/**
 * The default weight for CSS rules that layout a page.
 */
const CSS_LAYOUT = -100;

/**
107
 * The default weight for CSS rules that style design components (and their associated states and themes.)
108 109 110 111 112 113 114 115 116
 */
const CSS_COMPONENT = 0;

/**
 * The default weight for CSS rules that style states and are not included with components.
 */
const CSS_STATE = 100;

/**
117
 * The default weight for CSS rules that style themes and are not included with components.
118
 */
119
const CSS_THEME = 200;
120

121 122 123 124 125
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

126
/**
127
 * The default group for JavaScript and jQuery libraries added to the page.
128
 */
129
const JS_LIBRARY = -100;
130 131

/**
132
 * The default group for module JavaScript code added to the page.
133
 */
134
const JS_DEFAULT = 0;
135 136

/**
137
 * The default group for theme JavaScript code added to the page.
138
 */
139
const JS_THEME = 100;
140

141 142 143 144 145 146 147 148 149
/**
 * The delimiter used to split plural strings.
 *
 * This is the ETX (End of text) character and is used as a minimal means to
 * separate singular and plural variants in source and translation text. It
 * was found to be the most compatible delimiter for the supported databases.
 */
const LOCALE_PLURAL_DELIMITER = "\03";

150
/**
151
 * Prepares a 'destination' URL query parameter for use with url().
152
 *
153 154 155 156
 * Used to direct the user back to the referring page after completing a form.
 * By default the current URL is returned. If a destination exists in the
 * previous request, that destination is returned. As such, a destination can
 * persist across multiple pages.
157
 *
158
 * @return array
159
 *   An associative array containing the key:
160 161 162 163 164
 *   - destination: The value of the current request's 'destination' query
 *     parameter, if present. This can be either a relative or absolute URL.
 *     However, for security, redirection to external URLs is not performed.
 *     If the query parameter isn't present, then the URL of the current
 *     request is returned.
165
 *
166
 * @see \Drupal\Core\EventSubscriber\RedirectResponseSubscriber::checkRedirectUrl()
167
 *
168
 * @ingroup form_api
169 170 171
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use the redirect.destination service.
172 173
 */
function drupal_get_destination() {
174
  return \Drupal::destination()->getAsArray();
175 176
}

Kjartan's avatar
Kjartan committed
177
/**
Dries's avatar
 
Dries committed
178
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
179
 * @{
Dries's avatar
 
Dries committed
180
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
181 182
 */

183
/**
184
 * Verifies the syntax of the given email address.
Dries's avatar
 
Dries committed
185
 *
186
 * @param string $mail
187
 *   A string containing an email address.
188
 *
189
 * @return bool
Dries's avatar
 
Dries committed
190
 *   TRUE if the address is in a valid format.
191 192 193
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use \Drupal::service('email.validator')->isValid().
194
 */
Dries's avatar
 
Dries committed
195
function valid_email_address($mail) {
196
  return \Drupal::service('email.validator')->isValid($mail);
197 198
}

199 200 201 202
/**
 * @} End of "defgroup validation".
 */

203 204 205 206
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
207
 *
208
 * See https://www.drupal.org/writing-secure-code for information
209
 * on writing secure code.
210 211
 */

212
/**
213
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
214 215 216 217
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
218
 * @return string
219 220
 *   A URI stripped of dangerous protocols and encoded for output to an HTML
 *   attribute value. Because it is already encoded, it should not be set as a
221 222 223
 *   value within a $attributes array passed to Drupal\Core\Template\Attribute,
 *   because Drupal\Core\Template\Attribute expects those values to be
 *   plain-text strings. To pass a filtered URI to
224
 *   Drupal\Core\Template\Attribute, call
225
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
226
 *
227
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
228 229 230 231 232 233 234 235 236 237 238
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use UrlHelper::stripDangerousProtocols() or UrlHelper::filterBadProtocol()
 *   instead. UrlHelper::stripDangerousProtocols() can be used in conjunction
 *   with \Drupal\Component\Utility\SafeMarkup::format() and an @variable
 *   placeholder which will perform the necessary escaping.
 *   UrlHelper::filterBadProtocol() is functionality equivalent to check_url()
 *   apart from the fact it is protected from double escaping bugs. Note that
 *   this method no longer marks its output as safe.
 *
Dries's avatar
Dries committed
239 240
 */
function check_url($uri) {
241
  return Html::escape(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
242 243
}

244 245 246 247
/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
248
/**
Dries's avatar
 
Dries committed
249
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
250
 * @{
Dries's avatar
 
Dries committed
251
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
252 253 254
 */

/**
255
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
256
 *
Dries's avatar
 
Dries committed
257
 * @param $size
258
 *   A size in bytes.
259
 * @param $langcode
260 261
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
262
 *
Dries's avatar
 
Dries committed
263 264
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
265
 */
266
function format_size($size, $langcode = NULL) {
267
  if ($size < Bytes::KILOBYTE) {
268
    return \Drupal::translation()->formatPlural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
269
  }
270
  else {
271
    $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes.
272
    $units = array(
273 274 275 276 277 278 279 280
      t('@size KB', array(), array('langcode' => $langcode)),
      t('@size MB', array(), array('langcode' => $langcode)),
      t('@size GB', array(), array('langcode' => $langcode)),
      t('@size TB', array(), array('langcode' => $langcode)),
      t('@size PB', array(), array('langcode' => $langcode)),
      t('@size EB', array(), array('langcode' => $langcode)),
      t('@size ZB', array(), array('langcode' => $langcode)),
      t('@size YB', array(), array('langcode' => $langcode)),
281 282
    );
    foreach ($units as $unit) {
283 284
      if (round($size, 2) >= Bytes::KILOBYTE) {
        $size = $size / Bytes::KILOBYTE;
285 286 287 288
      }
      else {
        break;
      }
289
    }
290
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
291 292 293
  }
}

Dries's avatar
 
Dries committed
294
/**
295
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
296
 *
Dries's avatar
 
Dries committed
297
 * @param $timestamp
298
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
299
 * @param $type
300
 *   (optional) The format to use, one of:
301 302 303
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
304
 *   - The name of a date type defined by a date format config entity.
305 306 307
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
308
 * @param $format
309 310 311
 *   (optional) If $type is 'custom', a PHP date format string suitable for
 *   input to date(). Use a backslash to escape ordinary text, so it does not
 *   get interpreted as date format characters.
Dries's avatar
 
Dries committed
312
 * @param $timezone
313
 *   (optional) Time zone identifier, as described at
314
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
315
 *   display the page.
316
 * @param $langcode
317 318 319
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
320 321
 * @return
 *   A translated date string in the requested format.
322
 *
323
 * @see \Drupal\Core\Datetime\DateFormatter::format()
324 325 326
 *
 * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
 *   Use \Drupal::service('date.formatter')->format().
Dries's avatar
 
Dries committed
327
 */
328
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
329
  return \Drupal::service('date.formatter')->format($timestamp, $type, $format, $timezone, $langcode);
330 331
}

332 333 334 335 336
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
337
 *
338 339 340 341 342 343 344 345 346
 * @return string
 *   An ISO8601 formatted date.
 */
function date_iso8601($date) {
  // The DATE_ISO8601 constant cannot be used here because it does not match
  // date('c') and produces invalid RDF markup.
  return date('c', $date);
}

Dries's avatar
 
Dries committed
347 348 349
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
350

351
/**
352
 * Formats an attribute string for an HTTP header.
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
 *
 * @param $attributes
 *   An associative array of attributes such as 'rel'.
 *
 * @return
 *   A ; separated string ready for insertion in a HTTP header. No escaping is
 *   performed for HTML entities, so this string is not safe to be printed.
 */
function drupal_http_header_attributes(array $attributes = array()) {
  foreach ($attributes as $attribute => &$data) {
    if (is_array($data)) {
      $data = implode(' ', $data);
    }
    $data = $attribute . '="' . $data . '"';
  }
  return $attributes ? ' ' . implode('; ', $attributes) : '';
}

371 372 373 374 375 376 377 378
/**
 * Attempts to set the PHP maximum execution time.
 *
 * This function is a wrapper around the PHP function set_time_limit().
 * When called, set_time_limit() restarts the timeout counter from zero.
 * In other words, if the timeout is the default 30 seconds, and 25 seconds
 * into script execution a call such as set_time_limit(20) is made, the
 * script will run for a total of 45 seconds before timing out.
379
 *
380 381 382 383 384
 * If the current time limit is not unlimited it is possible to decrease the
 * total time limit if the sum of the new time limit and the current time spent
 * running the script is inferior to the original time limit. It is inherent to
 * the way set_time_limit() works, it should rather be called with an
 * appropriate value every time you need to allocate a certain amount of time
385
 * to execute a task than only once at the beginning of the script.
386
 *
387 388 389 390 391 392 393 394 395
 * Before calling set_time_limit(), we check if this function is available
 * because it could be disabled by the server administrator. We also hide all
 * the errors that could occur when calling set_time_limit(), because it is
 * not possible to reliably ensure that PHP or a security extension will
 * not issue a warning/error if they prevent the use of this function.
 *
 * @param $time_limit
 *   An integer specifying the new time limit, in seconds. A value of 0
 *   indicates unlimited execution time.
396 397
 *
 * @ingroup php_wrappers
398 399 400
 */
function drupal_set_time_limit($time_limit) {
  if (function_exists('set_time_limit')) {
401 402
    $current = ini_get('max_execution_time');
    // Do not set time limit if it is currently unlimited.
403
    if ($current != 0) {
404 405
      @set_time_limit($time_limit);
    }
406 407 408
  }
}

409
/**
410
 * Returns the base URL path (i.e., directory) of the Drupal installation.
411
 *
412 413
 * base_path() adds a "/" to the beginning and end of the returned path if the
 * path is not empty. At the very least, this will return "/".
414
 *
415 416 417
 * Examples:
 * - http://example.com returns "/" because the path is empty.
 * - http://example.com/drupal/folder returns "/drupal/folder/".
418 419
 */
function base_path() {
420
  return $GLOBALS['base_path'];
421 422
}

423
/**
424
 * Deletes old cached CSS files.
425
 *
426 427
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
428
 */
429 430
function drupal_clear_css_cache() {
  \Drupal::service('asset.css.collection_optimizer')->deleteAll();
431 432
}

Steven Wittens's avatar
Steven Wittens committed
433
/**
434
 * Constructs an array of the defaults that are used for JavaScript assets.
435 436
 *
 * @param $data
437
 *   (optional) The default data parameter for the JavaScript asset array.
438
 *
439
 * @see hook_js_alter()
440 441 442 443
 */
function drupal_js_defaults($data = NULL) {
  return array(
    'type' => 'file',
444 445
    'group' => JS_DEFAULT,
    'weight' => 0,
446 447
    'scope' => 'header',
    'cache' => TRUE,
448
    'preprocess' => TRUE,
449
    'attributes' => array(),
450
    'version' => NULL,
451
    'data' => $data,
452
    'browsers' => array(),
453 454 455
  );
}

456
/**
457
 * Processes non-asset attachments in a render() structure.
458
 *
459 460 461 462
 * Libraries, JavaScript settings, feeds, HTML <head> tags and HTML <head> links
 * are attached to elements using the #attached property. The #attached property
 * is an associative array, where the keys are the attachment types and the
 * values are the attached data. For example:
463
 *
464
 * @code
465 466 467
 * $build['#attached'] = [
 *   'library' => ['core/jquery']
 * ];
468 469 470
 * $build['#attached']['http_header'] = [
 *   ['Content-Type', 'application/rss+xml; charset=utf-8'],
 * ];
471 472
 * @endcode
 *
473 474 475 476 477 478 479 480
 * The available keys are:
 * - 'library' (asset libraries)
 * - 'drupalSettings' (JavaScript settings)
 * - 'feed' (RSS feeds)
 * - 'html_head' (tags in HTML <head>)
 * - 'html_head_link' (<link> tags in HTML <head>)
 * - 'http_header' (HTTP headers)
 *
481 482
 * This function processes all non-asset attachments, to apply them to the
 * current response (that means all keys except 'library' and 'drupalSettings').
483
 *
484
 * @param array $elements
485
 *   The structured array describing the data being rendered.
486
 *
487
 * @see drupal_render()
488
 * @see hook_html_head_alter()
489
 * @see \Drupal\Core\Asset\AssetResolver
490 491
 * @see \Drupal\Core\EventSubscriber\FinishResponseSubscriber
 * @see \Symfony\Component\HttpKernel\KernelEvents::RESPONSE
492 493 494
 *
 * @throws LogicException
 *   When attaching something of a non-existing attachment type.
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
 *
 * @deprecated Will be removed before Drupal 8.0.0. Specify attached elements in
 *   the render array from a controller, using ['#attached']. They will be
 *   rendered into the response towards the end of the render process. For
 *   example:
 *   @code
 *   $build['#attached'] = [
 *     'library' => ['core/jquery']
 *   ];
 *   $build['#attached']['http_header'] = [
 *     ['Content-Type', 'application/rss+xml; charset=utf-8'],
 *   ];
 *   return $build;
 *   @endcode
 *   For manipulating attached renderable items in non-controller applications,
 *   there are three options:
 *   - Use hook_page_attachments() and/or hook_page_attachments_alter() to
 *     change attachments.
 *   - Set up an event subscriber for the
 *     Symfony\Component\HttpKernel\KernelEvents::RESPONSE event. See
 *     Drupal\Core\EventSubscriber\FinishResponseSubscriber for an example.
 *   - Specify $variables['#attached'] in theme preprocess functions.
 *   To render attachments without a controller, use the
 *   'bare_html_page_renderer' service.
519
 */
520
function drupal_process_attached(array $elements) {
521 522
  $build['#attached'] = $elements['#attached'];
  \Drupal::service('renderer')->render($build);
523 524
}

525
/**
526
 * Adds JavaScript to change the state of an element based on another element.
527
 *
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
 * A "state" means a certain property on a DOM element, such as "visible" or
 * "checked". A state can be applied to an element, depending on the state of
 * another element on the page. In general, states depend on HTML attributes and
 * DOM element properties, which change due to user interaction.
 *
 * Since states are driven by JavaScript only, it is important to understand
 * that all states are applied on presentation only, none of the states force
 * any server-side logic, and that they will not be applied for site visitors
 * without JavaScript support. All modules implementing states have to make
 * sure that the intended logic also works without JavaScript being enabled.
 *
 * #states is an associative array in the form of:
 * @code
 * array(
 *   STATE1 => CONDITIONS_ARRAY1,
 *   STATE2 => CONDITIONS_ARRAY2,
 *   ...
 * )
 * @endcode
 * Each key is the name of a state to apply to the element, such as 'visible'.
 * Each value is a list of conditions that denote when the state should be
 * applied.
 *
 * Multiple different states may be specified to act on complex conditions:
 * @code
 * array(
 *   'visible' => CONDITIONS,
 *   'checked' => OTHER_CONDITIONS,
 * )
 * @endcode
 *
 * Every condition is a key/value pair, whose key is a jQuery selector that
 * denotes another element on the page, and whose value is an array of
 * conditions, which must bet met on that element:
 * @code
 * array(
 *   'visible' => array(
 *     JQUERY_SELECTOR => REMOTE_CONDITIONS,
 *     JQUERY_SELECTOR => REMOTE_CONDITIONS,
 *     ...
 *   ),
 * )
 * @endcode
 * All conditions must be met for the state to be applied.
 *
 * Each remote condition is a key/value pair specifying conditions on the other
 * element that need to be met to apply the state to the element:
 * @code
 * array(
 *   'visible' => array(
 *     ':input[name="remote_checkbox"]' => array('checked' => TRUE),
 *   ),
 * )
 * @endcode
 *
 * For example, to show a textfield only when a checkbox is checked:
 * @code
 * $form['toggle_me'] = array(
 *   '#type' => 'checkbox',
 *   '#title' => t('Tick this box to type'),
 * );
 * $form['settings'] = array(
 *   '#type' => 'textfield',
 *   '#states' => array(
 *     // Only show this field when the 'toggle_me' checkbox is enabled.
 *     'visible' => array(
 *       ':input[name="toggle_me"]' => array('checked' => TRUE),
595
 *     ),
596 597 598 599 600 601 602
 *   ),
 * );
 * @endcode
 *
 * The following states may be applied to an element:
 * - enabled
 * - disabled
603 604
 * - required
 * - optional
605 606 607 608 609 610 611 612
 * - visible
 * - invisible
 * - checked
 * - unchecked
 * - expanded
 * - collapsed
 *
 * The following states may be used in remote conditions:
613 614
 * - empty
 * - filled
615 616
 * - checked
 * - unchecked
617 618
 * - expanded
 * - collapsed
619 620
 * - value
 *
621 622
 * The following states exist for both elements and remote conditions, but are
 * not fully implemented and may not change anything on the element:
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
 * - relevant
 * - irrelevant
 * - valid
 * - invalid
 * - touched
 * - untouched
 * - readwrite
 * - readonly
 *
 * When referencing select lists and radio buttons in remote conditions, a
 * 'value' condition must be used:
 * @code
 *   '#states' => array(
 *     // Show the settings if 'bar' has been selected for 'foo'.
 *     'visible' => array(
 *       ':input[name="foo"]' => array('value' => 'bar'),
 *     ),
 *   ),
 * @endcode
 *
 * @param $elements
 *   A renderable array element having a #states property as described above.
 *
 * @see form_example_states_form()
647 648
 */
function drupal_process_states(&$elements) {
649
  $elements['#attached']['library'][] = 'core/drupal.states';
650 651 652 653 654 655
  // Elements of '#type' => 'item' are not actual form input elements, but we
  // still want to be able to show/hide them. Since there's no actual HTML input
  // element available, setting #attributes does not make sense, but a wrapper
  // is available, so setting #wrapper_attributes makes it work.
  $key = ($elements['#type'] == 'item') ? '#wrapper_attributes' : '#attributes';
  $elements[$key]['data-drupal-states'] = JSON::encode($elements['#states']);
656 657
}

658
/**
659
 * Assists in attaching the tableDrag JavaScript behavior to a themed table.
660 661 662 663 664
 *
 * Draggable tables should be used wherever an outline or list of sortable items
 * needs to be arranged by an end-user. Draggable tables are very flexible and
 * can manipulate the value of form elements placed within individual columns.
 *
665 666
 * To set up a table to use drag and drop in place of weight select-lists or in
 * place of a form that contains parent relationships, the form must be themed
667 668
 * into a table. The table must have an ID attribute set and it
 * may be set as follows:
669
 * @code
670 671 672 673 674 675 676 677 678
 * $table = array(
 *   '#type' => 'table',
 *   '#header' => $header,
 *   '#rows' => $rows,
 *   '#attributes' => array(
 *     'id' => 'my-module-table',
 *   ),
 * );
 * return drupal_render($table);
679 680 681 682 683 684 685 686
 * @endcode
 *
 * In the theme function for the form, a special class must be added to each
 * form element within the same column, "grouping" them together.
 *
 * In a situation where a single weight column is being sorted in the table, the
 * classes could be added like this (in the theme function):
 * @code
687
 * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
688 689
 * @endcode
 *
690 691
 * Each row of the table must also have a class of "draggable" in order to
 * enable the drag handles:
692 693 694 695
 * @code
 * $row = array(...);
 * $rows[] = array(
 *   'data' => $row,
696
 *   'class' => array('draggable'),
697 698
 * );
 * @endcode
Dries's avatar
Dries committed
699
 *
700 701 702 703 704
 * When tree relationships are present, the two additional classes
 * 'tabledrag-leaf' and 'tabledrag-root' can be used to refine the behavior:
 * - Rows with the 'tabledrag-leaf' class cannot have child rows.
 * - Rows with the 'tabledrag-root' class cannot be nested under a parent row.
 *
705
 * Calling drupal_attach_tabledrag() would then be written as such:
706
 * @code
707 708 709 710 711
 * drupal_attach_tabledrag('my-module-table', array(
 *   'action' => 'order',
 *   'relationship' => 'sibling',
 *   'group' => 'my-elements-weight',
 * );
712 713 714
 * @endcode
 *
 * In a more complex case where there are several groups in one column (such as
715 716
 * the block regions on the admin/structure/block page), a separate subgroup
 * class must also be added to differentiate the groups.
717
 * @code
718
 * $form['my_elements'][$region][$delta]['weight']['#attributes']['class'] = array('my-elements-weight', 'my-elements-weight-' . $region);
719 720
 * @endcode
 *
721 722 723 724
 * The 'group' option is still 'my-element-weight', and the additional
 * 'subgroup' option will be passed in as 'my-elements-weight-' . $region. This
 * also means that you'll need to call drupal_attach_tabledrag() once for every
 * region added.
725 726 727
 *
 * @code
 * foreach ($regions as $region) {
728 729
 *   drupal_attach_tabledrag('my-module-table', array(
 *     'action' => 'order',
730
 *     'relationship' => 'sibling',
731
 *     'group' => 'my-elements-weight',
732
 *     'subgroup' => 'my-elements-weight-' . $region,
733
 *   ));
734 735 736 737 738
 * }
 * @endcode
 *
 * In a situation where tree relationships are present, adding multiple
 * subgroups is not necessary, because the table will contain indentations that
739
 * provide enough information about the sibling and parent relationships. See
740 741
 * MenuForm::BuildOverviewForm for an example creating a table
 * containing parent relationships.
742
 *
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
 * @param $element
 *   A form element to attach the tableDrag behavior to.
 * @param array $options
 *   These options are used to generate JavaScript settings necessary to
 *   configure the tableDrag behavior appropriately for this particular table.
 *   An associative array containing the following keys:
 *   - 'table_id': String containing the target table's id attribute.
 *     If the table does not have an id, one will need to be set,
 *     such as <table id="my-module-table">.
 *   - 'action': String describing the action to be done on the form item.
 *      Either 'match' 'depth', or 'order':
 *     - 'match' is typically used for parent relationships.
 *     - 'order' is typically used to set weights on other form elements with
 *       the same group.
 *     - 'depth' updates the target element with the current indentation.
 *   - 'relationship': String describing where the "action" option
 *     should be performed. Either 'parent', 'sibling', 'group', or 'self':
 *     - 'parent' will only look for fields up the tree.
 *     - 'sibling' will look for fields in the same group in rows above and
 *       below it.
 *     - 'self' affects the dragged row itself.
 *     - 'group' affects the dragged row, plus any children below it (the entire
 *       dragged group).
 *   - 'group': A class name applied on all related form elements for this action.
 *   - 'subgroup': (optional) If the group has several subgroups within it, this
 *     string should contain the class name identifying fields in the same
 *     subgroup.
 *   - 'source': (optional) If the $action is 'match', this string should contain
 *     the classname identifying what field will be used as the source value
 *     when matching the value in $subgroup.
 *   - 'hidden': (optional) The column containing the field elements may be
 *     entirely hidden from view dynamically when the JavaScript is loaded. Set
 *     to FALSE if the column should not be hidden.
 *   - 'limit': (optional) Limit the maximum amount of parenting in this table.
 *
778
 * @see MenuForm::BuildOverviewForm()
779
 */
780 781 782 783 784 785 786 787
function drupal_attach_tabledrag(&$element, array $options) {
  // Add default values to elements.
  $options = $options + array(
    'subgroup' => NULL,
    'source' => NULL,
    'hidden' => TRUE,
    'limit' => 0
  );
788

789 790 791 792
  $group = $options['group'];

  $tabledrag_id = &drupal_static(__FUNCTION__);
  $tabledrag_id = (!isset($tabledrag_id)) ? 0 : $tabledrag_id + 1;
793 794

  // If a subgroup or source isn't set, assume it is the same as the group.
795 796
  $target = isset($options['subgroup']) ? $options['subgroup'] : $group;
  $source = isset($options['source']) ? $options['source'] : $target;
797
  $element['#attached']['drupalSettings']['tableDrag'][$options['table_id']][$group][$tabledrag_id] = array(
798 799
    'target' => $target,
    'source' => $source,
800 801 802 803
    'relationship' => $options['relationship'],
    'action' => $options['action'],
    'hidden' => $options['hidden'],
    'limit' => $options['limit'],
804
  );
805

806
  $element['#attached']['library'][] = 'core/drupal.tabledrag';
807 808
}

809
/**
810
 * Deletes old cached JavaScript files and variables.
811 812 813
 *
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
814 815
 */
function drupal_clear_js_cache() {
816
  \Drupal::service('asset.js.collection_optimizer')->deleteAll();
817 818
}

819
/**
820
 * Pre-render callback: Renders a link into #markup.
821
 *
822 823
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Render\Element\Link::preRenderLink().
824
 */
825
function drupal_pre_render_link($element) {
826
  return Element\Link::preRenderLink($element);
827 828
}

829
/**
830
 * Pre-render callback: Collects child links into a single array.
831 832
 *
 * This function can be added as a pre_render callback for a renderable array,
833
 * usually one which will be themed by links.html.twig. It iterates through all
834 835 836 837 838 839 840 841 842 843 844 845 846
 * unrendered children of the element, collects any #links properties it finds,
 * merges them into the parent element's #links array, and prevents those
 * children from being rendered separately.
 *
 * The purpose of this is to allow links to be logically grouped into related
 * categories, so that each child group can be rendered as its own list of
 * links if drupal_render() is called on it, but calling drupal_render() on the
 * parent element will still produce a single list containing all the remaining
 * links, regardless of what group they were in.
 *
 * A typical example comes from node links, which are stored in a renderable
 * array similar to this:
 * @code
847
 * $build['links'] = array(
848
 *   '#theme' => 'links__node',
849
 *   '#pre_render' => array('drupal_pre_render_links'),
850 851 852 853
 *   'comment' => array(
 *     '#theme' => 'links__node__comment',
 *     '#links' => array(
 *       // An array of links associated with node comments, suitable for
854
 *       // passing in to links.html.twig.
855 856 857 858 859 860
 *     ),
 *   ),
 *   'statistics' => array(
 *     '#theme' => 'links__node__statistics',
 *     '#links' => array(
 *       // An array of links associated with node statistics, suitable for
861
 *       // passing in to links.html.twig.
862 863 864 865 866 867
 *     ),
 *   ),
 *   'translation' => array(
 *     '#theme' => 'links__node__translation',
 *     '#links' => array(
 *       // An array of links associated with node translation, suitable for
868
 *       // passing in to links.html.twig.
869 870 871 872 873 874 875
 *     ),
 *   ),
 * );
 * @endcode
 *
 * In this example, the links are grouped by functionality, which can be
 * helpful to themers who want to display certain kinds of links independently.
876
 * For example, adding this code to node.html.twig will result in the comment
877 878
 * links being rendered as a single list:
 * @code
879
 * {{ content.links.comment }}
880 881
 * @endcode
 *
882
 * (where a node's content has been transformed into $content before handing
883
 * control to the node.html.twig template).
884 885 886 887 888
 *
 * The pre_render function defined here allows the above flexibility, but also
 * allows the following code to be used to render all remaining links into a
 * single list, regardless of their group:
 * @code
889
 * {{ content.links }}
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
 * @endcode
 *
 * In the above example, this will result in the statistics and translation
 * links being rendered together in a single list (but not the comment links,
 * which were rendered previously on their own).
 *
 * Because of the way this function works, the individual properties of each
 * group (for example, a group-specific #theme property such as
 * 'links__node__comment' in the example above, or any other property such as
 * #attributes or #pre_render that is attached to it) are only used when that
 * group is rendered on its own. When the group is rendered together with other
 * children, these child-specific properties are ignored, and only the overall
 * properties of the parent are used.
 */
function drupal_pre_render_links($element) {
905
  $element += array('#links' => array(), '#attached' => array());
906
  foreach (Element::children($element) as $key) {
907 908 909
    $child = &$element[$key];
    // If the child has links which have not been printed yet and the user has
    // access to it, merge its links in to the parent.
910
    if (isset($child['#links']) && empty($child['#printed']) && Element::isVisibleElement($child)) {
911 912 913 914 915
      $element['#links'] += $child['#links'];
      // Mark the child as having been printed already (so that its links
      // cannot be mistakenly rendered twice).
      $child['#printed'] = TRUE;
    }
916 917
    // Merge attachments.
    if (isset($child['#attached'])) {
918
      $element['#attached'] = BubbleableMetadata::mergeAttachments($element['#attached'], $child['#attached']);
919
    }
920 921 922 923
  }
  return $element;
}

924 925 926
/**
 * Renders final HTML given a structured array tree.
 *
927 928
 * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use the
 *   'renderer' service instead.
929
 *
930
 * @see \Drupal\Core\Render\RendererInterface::renderRoot()
931 932
 */
function drupal_render_root(&$elements) {
933
  return \Drupal::service('renderer')->renderRoot($elements);
934 935
}

936
/**
937 938
 * Renders HTML given a structured array tree.
 *
939 940
 * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use the
 *   'renderer' service instead.
941
 *
942 943 944 945
 * @see \Drupal\Core\Render\RendererInterface::render()
 */
function drupal_render(&$elements, $is_recursive_call = FALSE) {
  return \Drupal::service('renderer')->render($elements, $is_recursive_call);
946 947 948
}

/**
949
 * Renders children of an element and concatenates them.
950
 *
951
 * @param array $element
952
 *   The structured array whose children shall be rendered.
953 954
 * @param array $children_keys
 *   (optional) If the keys of the element's children are already known, they