common.inc 46.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\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\StringTranslation\TranslatableString;
29
use Drupal\Core\Url;
30 31
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
32
use Drupal\Core\PhpStorage\PhpStorageFactory;
33
use Drupal\Component\Utility\NestedArray;
34
use Drupal\Core\Datetime\DrupalDateTime;
35
use Drupal\Core\Routing\GeneratorNotInitializedException;
36
use Drupal\Core\StringTranslation\PluralTranslatableString;
37
use Drupal\Core\Template\Attribute;
38
use Drupal\Core\Render\BubbleableMetadata;
39
use Drupal\Core\Render\Element;
40
use Drupal\Core\Session\AnonymousUserSession;
41

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/**
 * @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
67
 *   $my_substring = Unicode::substr($original_string, 0, 5);
68 69
 * @endcode
 *
70
 * @}
71 72
 */

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

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

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

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

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

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

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

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

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

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

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

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

143 144 145
/**
 * The delimiter used to split plural strings.
 *
146 147 148
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use \Drupal\Core\StringTranslation\PluralTranslatableString::DELIMITER
 *   instead.
149
 */
150
const LOCALE_PLURAL_DELIMITER = PluralTranslatableString::DELIMITER;
151

152
/**
153
 * Prepares a 'destination' URL query parameter for use with url().
154
 *
155 156 157 158
 * 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.
159
 *
160
 * @return array
161
 *   An associative array containing the key:
162 163 164 165 166
 *   - 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.
167
 *
168
 * @see \Drupal\Core\EventSubscriber\RedirectResponseSubscriber::checkRedirectUrl()
169
 *
170
 * @ingroup form_api
171 172 173
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use the redirect.destination service.
174 175
 */
function drupal_get_destination() {
176
  return \Drupal::destination()->getAsArray();
177 178
}

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

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

201 202 203 204
/**
 * @} End of "defgroup validation".
 */

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

214
/**
215
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
216 217 218 219
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
220
 * @return string
221 222
 *   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
223 224 225
 *   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
226
 *   Drupal\Core\Template\Attribute, call
227
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
228
 *
229
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
230 231 232 233 234 235 236 237 238 239 240
 * @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
241 242
 */
function check_url($uri) {
243
  return Html::escape(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
244 245
}

246 247 248 249
/**
 * @} End of "defgroup sanitization".
 */

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

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

Dries's avatar
 
Dries committed
306
/**
307
 * Formats a date, using a date type or a custom date format string.
Dries's avatar
 
Dries committed
308
 *
Dries's avatar
 
Dries committed
309
 * @param $timestamp
310
 *   A UNIX timestamp to format.
Dries's avatar
 
Dries committed
311
 * @param $type
312
 *   (optional) The format to use, one of:
313 314 315
 *   - One of the built-in formats: 'short', 'medium',
 *     'long', 'html_datetime', 'html_date', 'html_time',
 *     'html_yearless_date', 'html_week', 'html_month', 'html_year'.
316
 *   - The name of a date type defined by a date format config entity.
317 318 319
 *   - The machine name of an administrator-defined date format.
 *   - 'custom', to use $format.
 *   Defaults to 'medium'.
Dries's avatar
 
Dries committed
320
 * @param $format
321 322 323
 *   (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
324
 * @param $timezone
325
 *   (optional) Time zone identifier, as described at
326
 *   http://php.net/manual/timezones.php Defaults to the time zone used to
327
 *   display the page.
328
 * @param $langcode
329 330 331
 *   (optional) Language code to translate to. Defaults to the language used to
 *   display the page.
 *
Dries's avatar
 
Dries committed
332 333
 * @return
 *   A translated date string in the requested format.
334
 *
335
 * @see \Drupal\Core\Datetime\DateFormatter::format()
336 337 338
 *
 * @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
339
 */
340
function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
341
  return \Drupal::service('date.formatter')->format($timestamp, $type, $format, $timezone, $langcode);
342 343
}

344 345 346 347 348
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
 * @param $date
 *   A UNIX timestamp.
349
 *
350 351 352 353 354 355 356 357 358
 * @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
359 360 361
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
362

363
/**
364
 * Formats an attribute string for an HTTP header.
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
 *
 * @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) : '';
}

383 384 385 386 387 388 389 390
/**
 * 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.
391
 *
392 393 394 395 396
 * 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
397
 * to execute a task than only once at the beginning of the script.
398
 *
399 400 401 402 403 404 405 406 407
 * 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.
408 409
 *
 * @ingroup php_wrappers
410 411 412
 */
function drupal_set_time_limit($time_limit) {
  if (function_exists('set_time_limit')) {
413 414
    $current = ini_get('max_execution_time');
    // Do not set time limit if it is currently unlimited.
415
    if ($current != 0) {
416 417
      @set_time_limit($time_limit);
    }
418 419 420
  }
}

421
/**
422
 * Returns the base URL path (i.e., directory) of the Drupal installation.
423
 *
424 425
 * 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 "/".
426
 *
427 428 429
 * Examples:
 * - http://example.com returns "/" because the path is empty.
 * - http://example.com/drupal/folder returns "/drupal/folder/".
430 431
 */
function base_path() {
432
  return $GLOBALS['base_path'];
433 434
}

435
/**
436
 * Deletes old cached CSS files.
437
 *
438 439
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
440
 */
441 442
function drupal_clear_css_cache() {
  \Drupal::service('asset.css.collection_optimizer')->deleteAll();
443 444
}

Steven Wittens's avatar
Steven Wittens committed
445
/**
446
 * Constructs an array of the defaults that are used for JavaScript assets.
447 448
 *
 * @param $data
449
 *   (optional) The default data parameter for the JavaScript asset array.
450
 *
451
 * @see hook_js_alter()
452 453 454 455
 */
function drupal_js_defaults($data = NULL) {
  return array(
    'type' => 'file',
456 457
    'group' => JS_DEFAULT,
    'weight' => 0,
458 459
    'scope' => 'header',
    'cache' => TRUE,
460
    'preprocess' => TRUE,
461
    'attributes' => array(),
462
    'version' => NULL,
463
    'data' => $data,
464
    'browsers' => array(),
465 466 467
  );
}

468
/**
469
 * Processes non-asset attachments in a render() structure.
470
 *
471 472 473 474
 * 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:
475
 *
476
 * @code
477 478 479
 * $build['#attached'] = [
 *   'library' => ['core/jquery']
 * ];
480 481 482
 * $build['#attached']['http_header'] = [
 *   ['Content-Type', 'application/rss+xml; charset=utf-8'],
 * ];
483 484
 * @endcode
 *
485 486 487 488 489 490 491 492
 * 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)
 *
493 494
 * This function processes all non-asset attachments, to apply them to the
 * current response (that means all keys except 'library' and 'drupalSettings').
495
 *
496
 * @param array $elements
497
 *   The structured array describing the data being rendered.
498
 *
499
 * @see drupal_render()
500
 * @see hook_html_head_alter()
501
 * @see \Drupal\Core\Asset\AssetResolver
502 503
 * @see \Drupal\Core\EventSubscriber\FinishResponseSubscriber
 * @see \Symfony\Component\HttpKernel\KernelEvents::RESPONSE
504 505 506
 *
 * @throws LogicException
 *   When attaching something of a non-existing attachment type.
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
 *
 * @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.
531
 */
532
function drupal_process_attached(array $elements) {
533 534
  $build['#attached'] = $elements['#attached'];
  \Drupal::service('renderer')->render($build);
535 536
}

537
/**
538
 * Adds JavaScript to change the state of an element based on another element.
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 595 596 597 598 599 600 601 602 603 604 605 606
 * 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),
607
 *     ),
608 609 610 611 612 613 614
 *   ),
 * );
 * @endcode
 *
 * The following states may be applied to an element:
 * - enabled
 * - disabled
615 616
 * - required
 * - optional
617 618 619 620 621 622 623 624
 * - visible
 * - invisible
 * - checked
 * - unchecked
 * - expanded
 * - collapsed
 *
 * The following states may be used in remote conditions:
625 626
 * - empty
 * - filled
627 628
 * - checked
 * - unchecked
629 630
 * - expanded
 * - collapsed
631 632
 * - value
 *
633 634
 * The following states exist for both elements and remote conditions, but are
 * not fully implemented and may not change anything on the element:
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
 * - 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()
659 660
 */
function drupal_process_states(&$elements) {
661
  $elements['#attached']['library'][] = 'core/drupal.states';
662 663 664 665 666 667
  // 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']);
668 669
}

670
/**
671
 * Assists in attaching the tableDrag JavaScript behavior to a themed table.
672 673 674 675 676
 *
 * 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.
 *
677 678
 * 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
679 680
 * into a table. The table must have an ID attribute set and it
 * may be set as follows:
681
 * @code
682 683 684 685 686 687 688 689 690
 * $table = array(
 *   '#type' => 'table',
 *   '#header' => $header,
 *   '#rows' => $rows,
 *   '#attributes' => array(
 *     'id' => 'my-module-table',
 *   ),
 * );
 * return drupal_render($table);
691 692 693 694 695 696 697 698
 * @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
699
 * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
700 701
 * @endcode
 *
702 703
 * Each row of the table must also have a class of "draggable" in order to
 * enable the drag handles:
704 705 706 707
 * @code
 * $row = array(...);
 * $rows[] = array(
 *   'data' => $row,
708
 *   'class' => array('draggable'),
709 710
 * );
 * @endcode
Dries's avatar
Dries committed
711
 *
712 713 714 715 716
 * 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.
 *
717
 * Calling drupal_attach_tabledrag() would then be written as such:
718
 * @code
719 720 721 722 723
 * drupal_attach_tabledrag('my-module-table', array(
 *   'action' => 'order',
 *   'relationship' => 'sibling',
 *   'group' => 'my-elements-weight',
 * );
724 725 726
 * @endcode
 *
 * In a more complex case where there are several groups in one column (such as
727 728
 * the block regions on the admin/structure/block page), a separate subgroup
 * class must also be added to differentiate the groups.
729
 * @code
730
 * $form['my_elements'][$region][$delta]['weight']['#attributes']['class'] = array('my-elements-weight', 'my-elements-weight-' . $region);
731 732
 * @endcode
 *
733 734 735 736
 * 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.
737 738 739
 *
 * @code
 * foreach ($regions as $region) {
740 741
 *   drupal_attach_tabledrag('my-module-table', array(
 *     'action' => 'order',
742
 *     'relationship' => 'sibling',
743
 *     'group' => 'my-elements-weight',
744
 *     'subgroup' => 'my-elements-weight-' . $region,
745
 *   ));
746 747 748 749 750
 * }
 * @endcode
 *
 * In a situation where tree relationships are present, adding multiple
 * subgroups is not necessary, because the table will contain indentations that
751
 * provide enough information about the sibling and parent relationships. See
752 753
 * MenuForm::BuildOverviewForm for an example creating a table
 * containing parent relationships.
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
 * @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.
 *
790
 * @see MenuForm::BuildOverviewForm()
791
 */
792 793 794 795 796 797 798 799
function drupal_attach_tabledrag(&$element, array $options) {
  // Add default values to elements.
  $options = $options + array(
    'subgroup' => NULL,
    'source' => NULL,
    'hidden' => TRUE,
    'limit' => 0
  );
800

801 802 803 804
  $group = $options['group'];

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

  // If a subgroup or source isn't set, assume it is the same as the group.
807 808
  $target = isset($options['subgroup']) ? $options['subgroup'] : $group;
  $source = isset($options['source']) ? $options['source'] : $target;
809
  $element['#attached']['drupalSettings']['tableDrag'][$options['table_id']][$group][$tabledrag_id] = array(
810 811
    'target' => $target,
    'source' => $source,
812 813 814 815
    'relationship' => $options['relationship'],
    'action' => $options['action'],
    'hidden' => $options['hidden'],
    'limit' => $options['limit'],
816
  );
817

818
  $element['#attached']['library'][] = 'core/drupal.tabledrag';
819 820
}

821
/**
822
 * Deletes old cached JavaScript files and variables.
823 824 825
 *
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
826 827
 */
function drupal_clear_js_cache() {
828
  \Drupal::service('asset.js.collection_optimizer')->deleteAll();
829 830
}

831
/**
832
 * Pre-render callback: Renders a link into #markup.
833
 *
834 835
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Render\Element\Link::preRenderLink().
836
 */
837
function drupal_pre_render_link($element) {
838
  return Element\Link::preRenderLink($element);
839 840
}

841
/**
842
 * Pre-render callback: Collects child links into a single array.
843 844
 *
 * This function can be added as a pre_render callback for a renderable array,
845
 * usually one which will be themed by links.html.twig. It iterates through all
846 847 848 849 850 851 852 853 854 855 856 857 858
 * 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
859
 * $build['links'] = array(
860
 *   '#theme' => 'links__node',
861
 *   '#pre_render' => array('drupal_pre_render_links'),
862 863 864 865
 *   'comment' => array(
 *     '#theme' => 'links__node__comment',
 *     '#links' => array(
 *       // An array of links associated with node comments, suitable for
866
 *       // passing in to links.html.twig.
867 868 869 870 871 872
 *     ),
 *   ),
 *   'statistics' => array(
 *     '#theme' => 'links__node__statistics',
 *     '#links' => array(
 *       // An array of links associated with node statistics, suitable for
873
 *       // passing in to links.html.twig.
874 875 876 877 878 879
 *     ),
 *   ),
 *   'translation' => array(
 *     '#theme' => 'links__node__translation',
 *     '#links' => array(
 *       // An array of links associated with node translation, suitable for
880
 *       // passing in to links.html.twig.
881 882 883 884 885 886 887
 *     ),
 *   ),
 * );
 * @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.
888
 * For example, adding this code to node.html.twig will result in the comment
889 890
 * links being rendered as a single list:
 * @code
891
 * {{ content.links.comment }}
892 893
 * @endcode
 *
894
 * (where a node's content has been transformed into $content before handing
895
 * control to the node.html.twig template).
896 897 898 899 900
 *
 * 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
901
 * {{ content.links }}
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
 * @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) {
917
  $element += array('#links' => array(), '#attached' => array());
918
  foreach (Element::children($element) as $key) {
919 920 921
    $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.
922
    if (isset($child['#links']) && empty($child['#printed']) && Element::isVisibleElement($child)) {
923 924 925 926 927
      $element['#links'] += $child['#links'];
      // Mark the child as having been printed already (so that its links
      // cannot be mistakenly rendered twice).
      $child['#printed'] = TRUE;
    }
928 929
    // Merge attachments.
    if (isset($child['#attached'])) {
930
      $element['#attached'] = BubbleableMetadata::mergeAttachments($element['#attached'], $child['#attached']);
931
    }
932 933 934 935
  }
  return $element;
}

936 937