common.inc 49.9 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\Renderer;
26
use Drupal\Core\Site\Settings;
27
use Drupal\Core\Url;
28 29
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
30
use Drupal\Core\PhpStorage\PhpStorageFactory;
31
use Drupal\Component\Utility\NestedArray;
32
use Drupal\Core\Datetime\DrupalDateTime;
33
use Drupal\Core\Routing\GeneratorNotInitializedException;
34
use Drupal\Core\Template\Attribute;
35
use Drupal\Core\Render\BubbleableMetadata;
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
  if ($render) {
198
    return \Drupal::service('renderer')->renderPlain($elements);
199 200 201 202
  }
  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
 *
223
 * @ingroup form_api
224 225 226
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use the redirect.destination service.
227 228
 */
function drupal_get_destination() {
229
  return \Drupal::destination()->getAsArray();
230 231
}

Kjartan's avatar
Kjartan committed
232
/**
Dries's avatar
 
Dries committed
233
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
234
 * @{
Dries's avatar
 
Dries committed
235
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
236 237
 */

238
/**
239
 * Verifies the syntax of the given email address.
Dries's avatar
 
Dries committed
240
 *
241
 * @param string $mail
242
 *   A string containing an email address.
243
 *
244
 * @return bool
Dries's avatar
 
Dries committed
245
 *   TRUE if the address is in a valid format.
246 247 248
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use \Drupal::service('email.validator')->isValid().
249
 */
Dries's avatar
 
Dries committed
250
function valid_email_address($mail) {
251
  return \Drupal::service('email.validator')->isValid($mail);
252 253
}

254 255 256 257
/**
 * @} End of "defgroup validation".
 */

258 259 260 261
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
262
 *
263
 * See https://www.drupal.org/writing-secure-code for information
264
 * on writing secure code.
265 266
 */

267
/**
268
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
269 270 271 272 273 274 275
 *
 * @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
276 277 278
 *   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
279
 *   Drupal\Core\Template\Attribute, call
280
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
281
 *
282
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
283
 * @see \Drupal\Component\Utility\SafeMarkup::checkPlain()
Dries's avatar
Dries committed
284 285
 */
function check_url($uri) {
286
  return SafeMarkup::checkPlain(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
287 288
}

289 290 291 292
/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
293
/**
Dries's avatar
 
Dries committed
294
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
295
 * @{
Dries's avatar
 
Dries committed
296
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
297 298 299
 */

/**
300
 * Generates a string representation for the given byte count.
Dries's avatar
 
Dries committed
301
 *
Dries's avatar
 
Dries committed
302
 * @param $size
303
 *   A size in bytes.
304
 * @param $langcode
305 306
 *   Optional language code to translate to a language other than what is used
 *   to display the page.
307
 *
Dries's avatar
 
Dries committed
308 309
 * @return
 *   A translated string representation of the size.
Dries's avatar
 
Dries committed
310
 */
311
function format_size($size, $langcode = NULL) {
312
  if ($size < Bytes::KILOBYTE) {
313
    return \Drupal::translation()->formatPlural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
Dries's avatar
 
Dries committed
314
  }
315
  else {
316
    $size = $size / Bytes::KILOBYTE; // Convert bytes to kilobytes.
317
    $units = array(
318 319 320 321 322 323 324 325
      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)),
326 327
    );
    foreach ($units as $unit) {
328 329
      if (round($size, 2) >= Bytes::KILOBYTE) {
        $size = $size / Bytes::KILOBYTE;
330 331 332 333
      }
      else {
        break;
      }
334
    }
335
    return str_replace('@size', round($size, 2), $unit);
Dries's avatar
 
Dries committed
336 337 338
  }
}

Dries's avatar
 
Dries committed
339
/**
340
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
341
 *
Dries's avatar
 
Dries committed
342
 * @param $timestamp
343
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
344
 * @param $type
345
 *   (optional) The format to use, one of:
346 347 348
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
349
 *   - The name of a date type defined by a date format config entity.
350 351 352
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
353
 * @param $format
354 355 356
 *   (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
357
 * @param $timezone
358
 *   (optional) Time zone identifier, as described at
359
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
360
 *   display the page.
361
 * @param $langcode
362 363 364
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
365 366
 * @return
 *   A translated date string in the requested format.
367
 *
368
 * @see \Drupal\Core\Datetime\DateFormatter::format()
Dries's avatar
 
Dries committed
369
 */
370
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
371
  return \Drupal::service('date.formatter')->format($timestamp, $type, $format, $timezone, $langcode);
372 373
}

374 375 376 377 378
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
379
 *
380 381 382 383 384 385 386 387 388
 * @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
389 390 391
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
392

393
/**
394
 * Formats an attribute string for an HTTP header.
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
 *
 * @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) : '';
}

413 414 415 416 417 418 419 420
/**
 * 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.
421
 *
422 423 424 425 426
 * 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
427
 * to execute a task than only once at the beginning of the script.
428
 *
429 430 431 432 433 434 435 436 437
 * 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.
438 439
 *
 * @ingroup php_wrappers
440 441 442
 */
function drupal_set_time_limit($time_limit) {
  if (function_exists('set_time_limit')) {
443 444
    $current = ini_get('max_execution_time');
    // Do not set time limit if it is currently unlimited.
445
    if ($current != 0) {
446 447
      @set_time_limit($time_limit);
    }
448 449 450
  }
}

451
/**
452
 * Returns the base URL path (i.e., directory) of the Drupal installation.
453
 *
454 455
 * 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 "/".
456
 *
457 458 459
 * Examples:
 * - http://example.com returns "/" because the path is empty.
 * - http://example.com/drupal/folder returns "/drupal/folder/".
460 461
 */
function base_path() {
462
  return $GLOBALS['base_path'];
463 464
}

465
/**
466
 * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
467
 *
468
 * This function can be called as long the HTML header hasn't been sent, which
469
 * on normal pages is up through the preprocess step of _theme('html'). Adding
470 471
 * a link will overwrite a prior link with the exact same 'rel' and 'href'
 * attributes.
472
 *
473 474 475 476
 * @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.
477 478 479
 *
 * @deprecated in Drupal 8.0.x, will be removed before Drupal 8.0.0
 *   Use #attached on render arrays.
480
 */
481
function _drupal_add_html_head_link($attributes, $header = FALSE) {
482 483 484 485 486 487 488 489
  $element = array(
    '#tag' => 'link',
    '#attributes' => $attributes,
  );
  $href = $attributes['href'];

  if ($header) {
    // Also add a HTTP header "Link:".
490
    $href = '<' . SafeMarkup::checkPlain($attributes['href']) . '>;';
491
    unset($attributes['href']);
492
    $element['#attached']['http_header'][] = array('Link',  $href . drupal_http_header_attributes($attributes), TRUE);
493 494
  }

495
  _drupal_add_html_head($element, 'html_head_link:' . $attributes['rel'] . ':' . $href);
496 497
}

498
/**
499
 * Deletes old cached CSS files.
500
 *
501 502
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
503
 */
504 505
function drupal_clear_css_cache() {
  \Drupal::service('asset.css.collection_optimizer')->deleteAll();
506 507
}

Steven Wittens's avatar
Steven Wittens committed
508
/**
509
 * Constructs an array of the defaults that are used for JavaScript assets.
510 511
 *
 * @param $data
512
 *   (optional) The default data parameter for the JavaScript asset array.
513
 *
514
 * @see hook_js_alter()
515 516 517 518
 */
function drupal_js_defaults($data = NULL) {
  return array(
    'type' => 'file',
519 520 521
    'group' => JS_DEFAULT,
    'every_page' => FALSE,
    'weight' => 0,
522 523
    'scope' => 'header',
    'cache' => TRUE,
524
    'preprocess' => TRUE,
525
    'attributes' => array(),
526
    'version' => NULL,
527
    'data' => $data,
528
    'browsers' => array(),
529 530 531
  );
}

532
/**
533
 * Merges two #attached arrays.
534
 *
535
 * The values under the 'drupalSettings' key are merged in a special way, to
536
 * match the behavior of:
537 538 539 540 541
 *
 * @code
 *   jQuery.extend(true, {}, $settings_items[0], $settings_items[1], ...)
 * @endcode
 *
542
 * This means integer indices are preserved just like string indices are,
543 544 545 546
 * rather than re-indexed as is common in PHP array merging.
 *
 * Example:
 * @code
547
 * function module1_page_attachments(&$page) {
548
 *   $page['a']['#attached']['drupalSettings']['foo'] = ['a', 'b', 'c'];
549
 * }
550
 * function module2_page_attachments(&$page) {
551
 *   $page['#attached']['drupalSettings']['foo'] = ['d'];
552 553 554 555 556 557 558 559
 * }
 * // 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:
560 561
 * - Attaching JavaScript settings is idempotent: attaching the same settings
 *   twice does not change the output sent to the browser.
562 563 564 565
 * - 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.
 *
566 567 568 569 570 571 572
 * @param array $a
 *   An #attached array.
 * @param array $b
 *   Another #attached array.
 *
 * @return array
 *   The merged #attached array.
573 574
 *
 * @deprecated To be removed in Drupal 8.0.x. Use
575
 *   \Drupal\Core\Render\BubbleableMetadata::mergeAttachments() instead.
576 577
 */
function drupal_merge_attached(array $a, array $b) {
578
  return BubbleableMetadata::mergeAttachments($a, $b);
579 580
}

581
/**
582
 * Processes non-asset attachments in a render() structure.
583
 *
584 585 586 587
 * 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:
588
 *
589
 * @code
590 591 592
 * $build['#attached'] = [
 *   'library' => ['core/jquery']
 * ];
593 594 595
 * $build['#attached']['http_header'] = [
 *   ['Content-Type', 'application/rss+xml; charset=utf-8'],
 * ];
596 597
 * @endcode
 *
598 599 600 601 602 603 604 605
 * 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)
 *
606 607
 * This function processes all non-asset attachments, to apply them to the
 * current response (that means all keys except 'library' and 'drupalSettings').
608
 *
609
 * @param array $elements
610
 *   The structured array describing the data being rendered.
611
 *
612
 * @see drupal_render()
613 614 615 616
 * @see \Drupal\Core\Asset\AssetResolver
 *
 * @throws LogicException
 *   When attaching something of a non-existing attachment type.
617
 */
618 619 620 621
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]);
622 623
  }

624 625
  // Add additional types of attachments specified in the render() structure.
  foreach ($elements['#attached'] as $callback => $options) {
626
    foreach ($elements['#attached'][$callback] as $args) {
627 628 629 630 631 632
      // Limit the amount allowed entries.
      switch ($callback) {
        case 'html_head':
          call_user_func_array('_drupal_add_html_head', $args);
          break;
        case 'feed':
633 634 635 636 637 638 639
          $args = [[
            'href' => $args[0],
            'rel' => 'alternate',
            'title' => $args[1],
            'type' => 'application/rss+xml',
          ]];
          call_user_func_array('_drupal_add_html_head_link', $args);
640 641 642 643 644 645 646 647 648 649
          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));
      }
650
    }
651 652 653
  }
}

654
/**
655
 * Adds JavaScript to change the state of an element based on another element.
656
 *
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
 * 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),
724
 *     ),
725 726 727 728 729 730 731
 *   ),
 * );
 * @endcode
 *
 * The following states may be applied to an element:
 * - enabled
 * - disabled
732 733
 * - required
 * - optional
734 735 736 737 738 739 740 741
 * - visible
 * - invisible
 * - checked
 * - unchecked
 * - expanded
 * - collapsed
 *
 * The following states may be used in remote conditions:
742 743
 * - empty
 * - filled
744 745
 * - checked
 * - unchecked
746 747
 * - expanded
 * - collapsed
748 749
 * - value
 *
750 751
 * The following states exist for both elements and remote conditions, but are
 * not fully implemented and may not change anything on the element:
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
 * - 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()
776 777
 */
function drupal_process_states(&$elements) {
778
  $elements['#attached']['library'][] = 'core/drupal.states';
779 780 781 782 783 784
  // 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']);
785 786
}

787
/**
788
 * Assists in attaching the tableDrag JavaScript behavior to a themed table.
789 790 791 792 793
 *
 * 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.
 *
794 795
 * 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
796 797
 * into a table. The table must have an ID attribute set and it
 * may be set as follows:
798
 * @code
799 800 801 802 803 804 805 806 807
 * $table = array(
 *   '#type' => 'table',
 *   '#header' => $header,
 *   '#rows' => $rows,
 *   '#attributes' => array(
 *     'id' => 'my-module-table',
 *   ),
 * );
 * return drupal_render($table);
808 809 810 811 812 813 814 815
 * @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
816
 * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
817 818
 * @endcode
 *
819 820
 * Each row of the table must also have a class of "draggable" in order to
 * enable the drag handles:
821 822 823 824
 * @code
 * $row = array(...);
 * $rows[] = array(
 *   'data' => $row,
825
 *   'class' => array('draggable'),
826 827
 * );
 * @endcode
Dries's avatar
Dries committed
828
 *
829 830 831 832 833
 * 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.
 *
834
 * Calling drupal_attach_tabledrag() would then be written as such:
835
 * @code
836 837 838 839 840
 * drupal_attach_tabledrag('my-module-table', array(
 *   'action' => 'order',
 *   'relationship' => 'sibling',
 *   'group' => 'my-elements-weight',
 * );
841 842 843
 * @endcode
 *
 * In a more complex case where there are several groups in one column (such as
844 845
 * the block regions on the admin/structure/block page), a separate subgroup
 * class must also be added to differentiate the groups.
846
 * @code
847
 * $form['my_elements'][$region][$delta]['weight']['#attributes']['class'] = array('my-elements-weight', 'my-elements-weight-' . $region);
848 849
 * @endcode
 *
850 851 852 853
 * 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.
854 855 856
 *
 * @code
 * foreach ($regions as $region) {
857 858
 *   drupal_attach_tabledrag('my-module-table', array(
 *     'action' => 'order',
859
 *     'relationship' => 'sibling',
860
 *     'group' => 'my-elements-weight',
861
 *     'subgroup' => 'my-elements-weight-' . $region,
862
 *   ));
863 864 865 866 867
 * }
 * @endcode
 *
 * In a situation where tree relationships are present, adding multiple
 * subgroups is not necessary, because the table will contain indentations that
868
 * provide enough information about the sibling and parent relationships. See
869 870
 * MenuForm::BuildOverviewForm for an example creating a table
 * containing parent relationships.
871
 *
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
 * @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.
 *
907
 * @see MenuForm::BuildOverviewForm()
908
 */
909 910 911 912 913 914 915 916
function drupal_attach_tabledrag(&$element, array $options) {
  // Add default values to elements.
  $options = $options + array(
    'subgroup' => NULL,
    'source' => NULL,
    'hidden' => TRUE,
    'limit' => 0
  );
917

918 919 920 921
  $group = $options['group'];

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

  // If a subgroup or source isn't set, assume it is the same as the group.
924 925
  $target = isset($options['subgroup']) ? $options['subgroup'] : $group;
  $source = isset($options['source']) ? $options['source'] : $target;
926
  $element['#attached']['drupalSettings']['tableDrag'][$options['table_id']][$group][$tabledrag_id] = array(
927 928
    'target' => $target,
    'source' => $source,
929 930 931 932
    'relationship' => $options['relationship'],
    'action' => $options['action'],
    'hidden' => $options['hidden'],
    'limit' => $options['limit'],
933
  );
934

935
  $element['#attached']['library'][] = 'core/drupal.tabledrag';
936 937
}

938
/**
939
 * Deletes old cached JavaScript files and variables.
940 941 942
 *
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
943 944
 */
function drupal_clear_js_cache() {
945
  \Drupal::service('asset.js.collection_optimizer')->deleteAll();