common.inc 56.7 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\SafeMarkup;
19
use Drupal\Component\Utility\SortArray;
20
use Drupal\Component\Utility\String;
21
use Drupal\Component\Utility\Tags;
22
use Drupal\Component\Utility\UrlHelper;
23
use Drupal\Core\Asset\AttachedAssets;
24
use Drupal\Core\Cache\Cache;
25
use Drupal\Core\Language\LanguageInterface;
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\Element;
37
use Drupal\Core\Session\AnonymousUserSession;
38

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
/**
 * @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
64
 *   $my_substring = Unicode::substr($original_string, 0, 5);
65 66
 * @endcode
 *
67
 * @}
68 69
 */

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

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

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

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

/**
91
 * The default aggregation group for theme CSS files added to the page.
92
 */
93 94 95 96 97 98 99 100 101 102 103 104 105
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;

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

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

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

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

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

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

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

140 141 142 143 144 145 146 147 148
/**
 * 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";

Dries's avatar
Dries committed
149
/**
150
 * Adds output to the HEAD tag of the HTML page.
151
 *
152
 * This function can be called as long as the headers aren't sent. Pass no
153 154 155 156 157 158 159 160 161 162 163 164
 * arguments (or NULL for both) to retrieve the currently stored elements.
 *
 * @param $data
 *   A renderable array. If the '#type' key is not set then 'html_tag' will be
 *   added as the default '#type'.
 * @param $key
 *   A unique string key to allow implementations of hook_html_head_alter() to
 *   identify the element in $data. Required if $data is not NULL.
 *
 * @return
 *   An array of all stored HEAD elements.
 *
165
 * @see \Drupal\Core\Render\Element\HtmlTag::preRenderHtmlTag()
166 167 168
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
Dries's avatar
Dries committed
169
 */
170
function _drupal_add_html_head($data = NULL, $key = NULL) {
171
  $stored_head = &drupal_static(__FUNCTION__, array());
172 173 174 175 176 177

  if (isset($data) && isset($key)) {
    if (!isset($data['#type'])) {
      $data['#type'] = 'html_tag';
    }
    $stored_head[$key] = $data;
Dries's avatar
Dries committed
178 179 180 181
  }
  return $stored_head;
}

182
/**
183
 * Retrieves output to be displayed in the HEAD tag of the HTML page.
184 185 186 187 188 189
 *
 * @param bool $render
 *   If TRUE render the HEAD elements, otherwise return just the elements.
 *
 * @return string|array
 *   Return the rendered HTML head or the elements itself.
190 191 192
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
193
 */
194
function drupal_get_html_head($render = TRUE) {
195
  $elements = _drupal_add_html_head();
196
  \Drupal::moduleHandler()->alter('html_head', $elements);
197 198 199 200 201 202
  if ($render) {
    return drupal_render($elements);
  }
  else {
    return $elements;
  }
Dries's avatar
Dries committed
203 204
}

205
/**
206
 * Prepares a 'destination' URL query parameter for use with url().
207
 *
208 209 210 211
 * 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.
212
 *
213
 * @return array
214
 *   An associative array containing the key:
215 216 217 218 219
 *   - 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.
220
 *
221
 * @see \Drupal\Core\EventSubscriber\RedirectResponseSubscriber::checkRedirectUrl()
222
 * @ingroup form_api
223 224
 */
function drupal_get_destination() {
225 226 227 228 229 230
  $destination = &drupal_static(__FUNCTION__);

  if (isset($destination)) {
    return $destination;
  }

231
  $query = \Drupal::request()->query;
232 233
  if ($query->has('destination')) {
    $destination = array('destination' => $query->get('destination'));
234 235
  }
  else {
236
    $path = \Drupal::url('<current>');
237
    $query = UrlHelper::buildQuery(UrlHelper::filterQueryParameters($query->all()));
238
    if ($query != '') {
239
      $path .= '?' . $query;
240
    }
241 242 243 244 245
    $destination = array('destination' => $path);
  }
  return $destination;
}

Kjartan's avatar
Kjartan committed
246
/**
Dries's avatar
 
Dries committed
247
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
248
 * @{
Dries's avatar
 
Dries committed
249
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
250 251
 */

252
/**
253
 * Verifies the syntax of the given email address.
Dries's avatar
 
Dries committed
254
 *
255
 * @param string $mail
256
 *   A string containing an email address.
257
 *
258
 * @return bool
Dries's avatar
 
Dries committed
259
 *   TRUE if the address is in a valid format.
260 261 262
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use \Drupal::service('email.validator')->isValid().
263
 */
Dries's avatar
 
Dries committed
264
function valid_email_address($mail) {
265
  return \Drupal::service('email.validator')->isValid($mail);
266 267
}

268 269 270 271
/**
 * @} End of "defgroup validation".
 */

272 273 274 275
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
276 277 278
 *
 * See http://drupal.org/writing-secure-code for information
 * on writing secure code.
279 280
 */

281
/**
282
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
283 284 285 286 287 288 289
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
 * @return
 *   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
290 291 292
 *   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
293
 *   Drupal\Core\Template\Attribute, call
294
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
295
 *
296
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
297
 * @see \Drupal\Component\Utility\String::checkPlain()
Dries's avatar
Dries committed
298 299
 */
function check_url($uri) {
300
  return String::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
301 302
}

303 304 305 306
/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
307
/**
Dries's avatar
 
Dries committed
308
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
309
 * @{
Dries's avatar
 
Dries committed
310
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
311 312
 */

313
/**
314
 * Formats XML elements.
315
 *
316 317 318
 * Note: It is the caller's responsibility to sanitize any input parameters.
 * This function does not perform sanitization.
 *
319
 * @param $array
320
 *   An array where each item represents an element and is either a:
321 322
 *   - (key => value) pair (<key>value</key>)
 *   - Associative array with fields:
323 324
 *     - 'key': The element name. Element names are not sanitized, so do not
 *       pass user input.
325 326 327 328 329 330 331
 *     - 'value': element contents
 *     - 'attributes': associative array of element attributes
 *
 * In both cases, 'value' can be a simple string, or it can be another array
 * with the same format as $array itself for nesting.
 */
function format_xml_elements($array) {
332
  $output = '';
333 334
  foreach ($array as $key => $value) {
    if (is_numeric($key)) {
Dries's avatar
 
Dries committed
335
      if ($value['key']) {
336
        $output .= ' <' . $value['key'];
337
        if (isset($value['attributes']) && is_array($value['attributes'])) {
338
          $output .= new Attribute($value['attributes']);
Dries's avatar
 
Dries committed
339 340
        }

341
        if (isset($value['value']) && $value['value'] != '') {
342
          $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : String::checkPlain($value['value'])) . '</' . $value['key'] . ">\n";
Dries's avatar
 
Dries committed
343 344 345 346 347 348 349
        }
        else {
          $output .= " />\n";
        }
      }
    }
    else {
350
      $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : String::checkPlain($value)) . "</$key>\n";
Dries's avatar
 
Dries committed
351
    }
Dries's avatar
 
Dries committed
352
  }
353 354 355 356 357
  // @todo This is marking the output string as safe HTML, but we have only
  //   sanitized the attributes and tag values, not the tag names, and we
  //   cannot guarantee the assembled markup is safe. Consider a fix in:
  //   https://www.drupal.org/node/2296885
  return SafeMarkup::set($output);
Dries's avatar
 
Dries committed
358 359
}

Dries's avatar
 
Dries committed
360
/**
361
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
362
 *
Dries's avatar
 
Dries committed
363
 * @param $size
364
 *   A size in bytes.
365
 * @param $langcode
366 367
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
368
 *
Dries's avatar
 
Dries committed
369 370
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
371
 */
372
function format_size($size, $langcode = NULL) {
373
  if ($size < Bytes::KILOBYTE) {
374
    return \Drupal::translation()->formatPlural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
375
  }
376
  else {
377
    $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes.
378
    $units = array(
379 380 381 382 383 384 385 386
      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)),
387 388
    );
    foreach ($units as $unit) {
389 390
      if (round($size, 2) >= Bytes::KILOBYTE) {
        $size = $size / Bytes::KILOBYTE;
391 392 393 394
      }
      else {
        break;
      }
395
    }
396
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
397 398 399
  }
}

Dries's avatar
 
Dries committed
400
/**
401
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
402
 *
Dries's avatar
 
Dries committed
403
 * @param $timestamp
404
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
405
 * @param $type
406
 *   (optional) The format to use, one of:
407 408 409
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
410
 *   - The name of a date type defined by a date format config entity.
411 412 413
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
414
 * @param $format
415 416 417
 *   (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
418
 * @param $timezone
419
 *   (optional) Time zone identifier, as described at
420
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
421
 *   display the page.
422
 * @param $langcode
423 424 425
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
426 427
 * @return
 *   A translated date string in the requested format.
428
 *
429
 * @see \Drupal\Core\Datetime\DateFormatter::format()
Dries's avatar
 
Dries committed
430
 */
431
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
432
  return \Drupal::service('date.formatter')->format($timestamp, $type, $format, $timezone, $langcode);
433 434
}

435 436 437 438 439
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
440
 *
441 442 443 444 445 446 447 448 449
 * @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);
}

450
/**
451 452 453
 * Translates a formatted date string.
 *
 * Callback for preg_replace_callback() within format_date().
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
 */
function _format_date_callback(array $matches = NULL, $new_langcode = NULL) {
  // We cache translations to avoid redundant and rather costly calls to t().
  static $cache, $langcode;

  if (!isset($matches)) {
    $langcode = $new_langcode;
    return;
  }

  $code = $matches[1];
  $string = $matches[2];

  if (!isset($cache[$langcode][$code][$string])) {
    $options = array(
      'langcode' => $langcode,
    );

    if ($code == 'F') {
      $options['context'] = 'Long month name';
Dries's avatar
 
Dries committed
474
    }
475 476 477

    if ($code == '') {
      $cache[$langcode][$code][$string] = $string;
478
    }
Dries's avatar
 
Dries committed
479
    else {
480
      $cache[$langcode][$code][$string] = t($string, array(), $options);
Dries's avatar
 
Dries committed
481
    }
Dries's avatar
 
Dries committed
482
  }
483
  return $cache[$langcode][$code][$string];
Dries's avatar
 
Dries committed
484 485
}

Dries's avatar
 
Dries committed
486 487 488
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
489

490
/**
491
 * Formats an attribute string for an HTTP header.
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
 *
 * @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) : '';
}

510 511 512 513 514 515 516 517
/**
 * 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.
518
 *
519 520 521 522 523
 * 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
524
 * to execute a task than only once at the beginning of the script.
525
 *
526 527 528 529 530 531 532 533 534
 * 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.
535 536
 *
 * @ingroup php_wrappers
537 538 539
 */
function drupal_set_time_limit($time_limit) {
  if (function_exists('set_time_limit')) {
540 541
    $current = ini_get('max_execution_time');
    // Do not set time limit if it is currently unlimited.
542
    if ($current != 0) {
543 544
      @set_time_limit($time_limit);
    }
545 546 547
  }
}

548
/**
549
 * Returns the base URL path (i.e., directory) of the Drupal installation.
550
 *
551 552
 * 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 "/".
553
 *
554 555 556
 * Examples:
 * - http://example.com returns "/" because the path is empty.
 * - http://example.com/drupal/folder returns "/drupal/folder/".
557 558
 */
function base_path() {
559
  return $GLOBALS['base_path'];
560 561
}

562
/**
563
 * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
564
 *
565
 * This function can be called as long the HTML header hasn't been sent, which
566
 * on normal pages is up through the preprocess step of _theme('html'). Adding
567 568
 * a link will overwrite a prior link with the exact same 'rel' and 'href'
 * attributes.
569
 *
570 571 572 573
 * @param $attributes
 *   Associative array of element attributes including 'href' and 'rel'.
 * @param $header
 *   Optional flag to determine if a HTTP 'Link:' header should be sent.
574 575 576
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
577
 */
578
function _drupal_add_html_head_link($attributes, $header = FALSE) {
579 580 581 582 583 584 585 586
  $element = array(
    '#tag' => 'link',
    '#attributes' => $attributes,
  );
  $href = $attributes['href'];

  if ($header) {
    // Also add a HTTP header "Link:".
587
    $href = '<' . String::checkPlain($attributes['href']) . '>;';
588
    unset($attributes['href']);
589
    $element['#attached']['http_header'][] = array('Link',  $href . drupal_http_header_attributes($attributes), TRUE);
590 591
  }

592
  _drupal_add_html_head($element, 'html_head_link:' . $attributes['rel'] . ':' . $href);
593 594
}

595
/**
596
 * Deletes old cached CSS files.
597
 *
598 599
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
600
 */
601 602
function drupal_clear_css_cache() {
  \Drupal::service('asset.css.collection_optimizer')->deleteAll();
603 604
}

Steven Wittens's avatar
Steven Wittens committed
605
/**
606
 * Constructs an array of the defaults that are used for JavaScript assets.
607 608
 *
 * @param $data
609
 *   (optional) The default data parameter for the JavaScript asset array.
610
 *
611
 * @see hook_js_alter()
612 613 614 615
 */
function drupal_js_defaults($data = NULL) {
  return array(
    'type' => 'file',
616 617 618
    'group' => JS_DEFAULT,
    'every_page' => FALSE,
    'weight' => 0,
619 620
    'scope' => 'header',
    'cache' => TRUE,
621
    'preprocess' => TRUE,
622
    'attributes' => array(),
623
    'version' => NULL,
624
    'data' => $data,
625
    'browsers' => array(),
626 627 628
  );
}

629
/**
630
 * Merges two #attached arrays.
631
 *
632
 * The values under the 'drupalSettings' key are merged in a special way, to
633
 * match the behavior of:
634 635 636 637 638
 *
 * @code
 *   jQuery.extend(true, {}, $settings_items[0], $settings_items[1], ...)
 * @endcode
 *
639
 * This means integer indices are preserved just like string indices are,
640 641 642 643
 * rather than re-indexed as is common in PHP array merging.
 *
 * Example:
 * @code
644
 * function module1_page_attachments(&$page) {
645
 *   $page['a']['#attached']['drupalSettings']['foo'] = ['a', 'b', 'c'];
646
 * }
647
 * function module2_page_attachments(&$page) {
648
 *   $page['#attached']['drupalSettings']['foo'] = ['d'];
649 650 651 652 653 654 655 656
 * }
 * // When the page is rendered after the above code, and the browser runs the
 * // resulting <SCRIPT> tags, the value of drupalSettings.foo is
 * // ['d', 'b', 'c'], not ['a', 'b', 'c', 'd'].
 * @endcode
 *
 * By following jQuery.extend() merge logic rather than common PHP array merge
 * logic, the following are ensured:
657 658
 * - Attaching JavaScript settings is idempotent: attaching the same settings
 *   twice does not change the output sent to the browser.
659 660 661 662
 * - If pieces of the page are rendered in separate PHP requests and the
 *   returned settings are merged by JavaScript, the resulting settings are the
 *   same as if rendered in one PHP request and merged by PHP.
 *
663 664 665 666 667 668 669
 * @param array $a
 *   An #attached array.
 * @param array $b
 *   Another #attached array.
 *
 * @return array
 *   The merged #attached array.
670 671 672
 *
 * @deprecated To be removed in Drupal 8.0.x. Use
 *   \Drupal\Core\Render\Renderer::mergeAttachments() instead.
673 674
 */
function drupal_merge_attached(array $a, array $b) {
675
  return Renderer::mergeAttachments($a, $b);
676 677
}

678
/**
679
 * Processes non-asset attachments in a render() structure.
680
 *
681 682 683 684
 * 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:
685
 *
686
 * @code
687 688 689
 * $build['#attached'] = [
 *   'library' => ['core/jquery']
 * ];
690 691 692
 * $build['#attached']['http_header'] = [
 *   ['Content-Type', 'application/rss+xml; charset=utf-8'],
 * ];
693 694
 * @endcode
 *
695 696 697 698 699 700 701 702
 * 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)
 *
703 704
 * This function processes all non-asset attachments, to apply them to the
 * current response (that means all keys except 'library' and 'drupalSettings').
705
 *
706
 * @param array $elements
707
 *   The structured array describing the data being rendered.
708
 *
709
 * @see drupal_render()
710 711 712 713
 * @see \Drupal\Core\Asset\AssetResolver
 *
 * @throws LogicException
 *   When attaching something of a non-existing attachment type.
714
 */
715 716 717 718
function drupal_process_attached(array $elements) {
  // Asset attachments are handled by \Drupal\Core\Asset\AssetResolver.
  foreach (array('library', 'drupalSettings') as $type) {
    unset($elements['#attached'][$type]);
719 720
  }

721 722
  // Add additional types of attachments specified in the render() structure.
  foreach ($elements['#attached'] as $callback => $options) {
723
    foreach ($elements['#attached'][$callback] as $args) {
724 725 726 727 728 729
      // Limit the amount allowed entries.
      switch ($callback) {
        case 'html_head':
          call_user_func_array('_drupal_add_html_head', $args);
          break;
        case 'feed':
730 731 732 733 734 735 736
          $args = [[
            'href' => $args[0],
            'rel' => 'alternate',
            'title' => $args[1],
            'type' => 'application/rss+xml',
          ]];
          call_user_func_array('_drupal_add_html_head_link', $args);
737 738 739 740 741 742 743 744 745 746
          break;
        case 'html_head_link':
          call_user_func_array('_drupal_add_html_head_link', $args);
          break;
        case 'http_header':
          call_user_func_array('_drupal_add_http_header', $args);
          break;
        default:
          throw new \LogicException(sprintf('You are not allowed to use %s in #attached', $callback));
      }
747
    }
748 749 750
  }
}

751
/**
752
 * Adds JavaScript to change the state of an element based on another element.
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 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
 * 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),
821
 *     ),
822 823 824 825 826 827 828
 *   ),
 * );
 * @endcode
 *
 * The following states may be applied to an element:
 * - enabled
 * - disabled
829 830
 * - required
 * - optional
831 832 833 834 835 836 837 838
 * - visible
 * - invisible
 * - checked
 * - unchecked
 * - expanded
 * - collapsed
 *
 * The following states may be used in remote conditions:
839 840
 * - empty
 * - filled
841 842
 * - checked
 * - unchecked
843 844
 * - expanded
 * - collapsed
845 846
 * - value
 *
847 848
 * The following states exist for both elements and remote conditions, but are
 * not fully implemented and may not change anything on the element:
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
 * - 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()
873 874
 */
function drupal_process_states(&$elements) {
875
  $elements['#attached']['library'][] = 'core/drupal.states';
876 877 878 879 880 881
  // 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']);
882 883
}

884
/**
885
 * Assists in attaching the tableDrag JavaScript behavior to a themed table.
886 887 888 889 890
 *
 * 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.
 *
891 892
 * 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
893 894
 * into a table. The table must have an ID attribute set and it
 * may be set as follows:
895
 * @code
896 897 898 899 900 901 902 903 904
 * $table = array(
 *   '#type' => 'table',
 *   '#header' => $header,
 *   '#rows' => $rows,
 *   '#attributes' => array(
 *     'id' => 'my-module-table',
 *   ),
 * );
 * return drupal_render($table);
905 906 907 908 909 910 911 912
 * @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
913
 * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
914 915
 * @endcode
 *
916 917
 * Each row of the table must also have a class of "draggable" in order to
 * enable the drag handles:
918 919 920 921
 * @code
 * $row = array(...);
 * $rows[] = array(
 *   'data' => $row,
922
 *   'class' => array('draggable'),
923 924
 * );
 * @endcode
Dries's avatar
Dries committed
925
 *
926 927 928 929 930
 * 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.
 *
931
 * Calling drupal_attach_tabledrag() would then be written as such:
932
 * @code
933 934 935 936 937