common.inc 45.1 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
use Drupal\Component\Utility\Bytes;
13
use Drupal\Component\Utility\Html;
14
use Drupal\Component\Utility\SortArray;
15
use Drupal\Component\Utility\UrlHelper;
16
use Drupal\Core\Cache\Cache;
17
use Drupal\Core\Render\HtmlResponseAttachmentsProcessor;
18
use Drupal\Core\Render\Element\Link;
19 20 21
use Drupal\Core\Render\Markup;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\StringTranslation\PluralTranslatableMarkup;
22
use Drupal\Core\Render\BubbleableMetadata;
23
use Drupal\Core\Render\Element;
24

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
/**
 * @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
50
 *   $my_substring = mb_substr($original_string, 0, 5);
51 52
 * @endcode
 *
53
 * @}
54 55
 */

56 57 58
/**
 * Return status for saving which involved creating a new item.
 */
59
const SAVED_NEW = 1;
60 61 62 63

/**
 * Return status for saving which involved an update to an existing item.
 */
64
const SAVED_UPDATED = 2;
65 66 67 68

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

71
/**
72
 * The default aggregation group for CSS files added to the page.
73
 */
74
const CSS_AGGREGATE_DEFAULT = 0;
75 76

/**
77
 * The default aggregation group for theme CSS files added to the page.
78
 */
79 80 81 82 83 84 85 86 87 88 89 90 91
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;

/**
92
 * The default weight for CSS rules that style design components (and their associated states and themes.)
93 94 95 96 97 98 99 100 101
 */
const CSS_COMPONENT = 0;

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

/**
102
 * The default weight for CSS rules that style themes and are not included with components.
103
 */
104
const CSS_THEME = 200;
105

106 107 108 109 110
/**
 * The default group for JavaScript settings added to the page.
 */
const JS_SETTING = -200;

111
/**
112
 * The default group for JavaScript and jQuery libraries added to the page.
113
 */
114
const JS_LIBRARY = -100;
115 116

/**
117
 * The default group for module JavaScript code added to the page.
118
 */
119
const JS_DEFAULT = 0;
120 121

/**
122
 * The default group for theme JavaScript code added to the page.
123
 */
124
const JS_THEME = 100;
125

126 127 128
/**
 * The delimiter used to split plural strings.
 *
129
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
130
 *   Use \Drupal\Core\StringTranslation\PluralTranslatableMarkup::DELIMITER
131
 *   instead.
132
 */
133
const LOCALE_PLURAL_DELIMITER = PluralTranslatableMarkup::DELIMITER;
134

135
/**
136
 * Prepares a 'destination' URL query parameter.
137
 *
138 139 140 141
 * 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.
142
 *
143
 * @return array
144
 *   An associative array containing the key:
145 146 147 148 149
 *   - 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.
150
 *
151
 * @ingroup form_api
152 153 154
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use the redirect.destination service.
155 156 157
 *
 * @see \Drupal\Core\EventSubscriber\RedirectResponseSubscriber::checkRedirectUrl()
 * @see https://www.drupal.org/node/2448603
158 159
 */
function drupal_get_destination() {
160
  return \Drupal::destination()->getAsArray();
161 162
}

Kjartan's avatar
Kjartan committed
163
/**
Dries's avatar
 
Dries committed
164
 * @defgroup validation Input validation
Dries's avatar
 
Dries committed
165
 * @{
Dries's avatar
 
Dries committed
166
 * Functions to validate user input.
Kjartan's avatar
Kjartan committed
167 168
 */

169
/**
170
 * Verifies the syntax of the given email address.
Dries's avatar
 
Dries committed
171
 *
172
 * @param string $mail
173
 *   A string containing an email address.
174
 *
175
 * @return bool
Dries's avatar
 
Dries committed
176
 *   TRUE if the address is in a valid format.
177 178 179
 *
 * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
 *   Use \Drupal::service('email.validator')->isValid().
180 181
 *
 * @see https://www.drupal.org/node/2912661
182
 */
Dries's avatar
 
Dries committed
183
function valid_email_address($mail) {
184
  return \Drupal::service('email.validator')->isValid($mail);
185 186
}

187 188 189 190
/**
 * @} End of "defgroup validation".
 */

191 192 193 194
/**
 * @defgroup sanitization Sanitization functions
 * @{
 * Functions to sanitize values.
195
 *
196
 * See https://www.drupal.org/writing-secure-code for information
197
 * on writing secure code.
198 199
 */

200
/**
201
 * Strips dangerous protocols from a URI and encodes it for output to HTML.
202 203 204 205
 *
 * @param $uri
 *   A plain-text URI that might contain dangerous protocols.
 *
206
 * @return string
207 208
 *   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
209 210 211
 *   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
212
 *   Drupal\Core\Template\Attribute, call
213
 *   \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() instead.
214
 *
215 216 217
 * @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
218
 *   with \Drupal\Component\Render\FormattableMarkup and an @variable
219 220 221 222
 *   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.
223 224 225 226
 *
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
 * @see https://www.drupal.org/node/2560027
Dries's avatar
Dries committed
227 228
 */
function check_url($uri) {
229
  return Html::escape(UrlHelper::stripDangerousProtocols($uri));
Dries's avatar
Dries committed
230 231
}

232 233 234 235
/**
 * @} End of "defgroup sanitization".
 */

Dries's avatar
 
Dries committed
236
/**
Dries's avatar
 
Dries committed
237
 * @defgroup format Formatting
Dries's avatar
 
Dries committed
238
 * @{
Dries's avatar
 
Dries committed
239
 * Functions to format numbers, strings, dates, etc.
Dries's avatar
 
Dries committed
240 241 242
 */

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

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

332 333 334
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
335
 * @param string $date
336
 *   A UNIX timestamp.
337
 *
338 339
 * @return string
 *   An ISO8601 formatted date.
340 341 342 343 344
 *
 * @deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use
 *   date('c', $date) instead.
 *
 * @see https://www.drupal.org/node/2999991
345 346
 */
function date_iso8601($date) {
347
  @trigger_error('date_iso8601() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use date("c", $date) instead. See https://www.drupal.org/node/2999991.', E_USER_DEPRECATED);
348 349 350 351 352
  // 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
353 354 355
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
356

357
/**
358
 * Formats an attribute string for an HTTP header.
359
 *
360
 * @param array $attributes
361 362
 *   An associative array of attributes such as 'rel'.
 *
363
 * @return string
364 365
 *   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.
366 367 368 369 370 371
 *
 * @deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use
 *   \Drupal\Core\Render\HtmlResponseAttachmentsProcessor::formatHttpHeaderAttributes()
 *   instead.
 *
 * @see https://www.drupal.org/node/3000051
372
 */
373
function drupal_http_header_attributes(array $attributes = []) {
374
  @trigger_error("drupal_http_header_attributes() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Render\HtmlResponseAttachmentsProcessor::formatHttpHeaderAttributes() instead. See https://www.drupal.org/node/3000051", E_USER_DEPRECATED);
375
  return HtmlResponseAttachmentsProcessor::formatHttpHeaderAttributes($attributes);
376 377
}

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

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

430
/**
431
 * Deletes old cached CSS files.
432
 *
433 434
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
435 436
 *
 * @see https://www.drupal.org/node/2317841
437
 */
438 439
function drupal_clear_css_cache() {
  \Drupal::service('asset.css.collection_optimizer')->deleteAll();
440 441
}

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

465
/**
466
 * Adds JavaScript to change the state of an element based on another element.
467
 *
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
 * 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),
535
 *     ),
536 537 538 539 540 541 542
 *   ),
 * );
 * @endcode
 *
 * The following states may be applied to an element:
 * - enabled
 * - disabled
543 544
 * - required
 * - optional
545 546 547 548 549 550 551 552
 * - visible
 * - invisible
 * - checked
 * - unchecked
 * - expanded
 * - collapsed
 *
 * The following states may be used in remote conditions:
553 554
 * - empty
 * - filled
555 556
 * - checked
 * - unchecked
557 558
 * - expanded
 * - collapsed
559 560
 * - value
 *
561 562
 * The following states exist for both elements and remote conditions, but are
 * not fully implemented and may not change anything on the element:
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
 * - 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()
587 588
 */
function drupal_process_states(&$elements) {
589
  $elements['#attached']['library'][] = 'core/drupal.states';
590 591 592 593 594
  // 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';
595
  $elements[$key]['data-drupal-states'] = Json::encode($elements['#states']);
596 597
}

598
/**
599
 * Assists in attaching the tableDrag JavaScript behavior to a themed table.
600 601 602 603 604
 *
 * 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.
 *
605 606
 * 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
607 608
 * into a table. The table must have an ID attribute set and it
 * may be set as follows:
609
 * @code
610 611 612 613 614 615 616 617
 * $table = array(
 *   '#type' => 'table',
 *   '#header' => $header,
 *   '#rows' => $rows,
 *   '#attributes' => array(
 *     'id' => 'my-module-table',
 *   ),
 * );
618
 * return \Drupal::service('renderer')->render($table);
619 620 621 622 623 624 625 626
 * @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
627
 * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
628 629
 * @endcode
 *
630 631
 * Each row of the table must also have a class of "draggable" in order to
 * enable the drag handles:
632 633 634 635
 * @code
 * $row = array(...);
 * $rows[] = array(
 *   'data' => $row,
636
 *   'class' => array('draggable'),
637 638
 * );
 * @endcode
Dries's avatar
Dries committed
639
 *
640 641 642 643 644
 * 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.
 *
645
 * Calling drupal_attach_tabledrag() would then be written as such:
646
 * @code
647 648 649 650 651
 * drupal_attach_tabledrag('my-module-table', array(
 *   'action' => 'order',
 *   'relationship' => 'sibling',
 *   'group' => 'my-elements-weight',
 * );
652 653 654
 * @endcode
 *
 * In a more complex case where there are several groups in one column (such as
655 656
 * the block regions on the admin/structure/block page), a separate subgroup
 * class must also be added to differentiate the groups.
657
 * @code
658
 * $form['my_elements'][$region][$delta]['weight']['#attributes']['class'] = array('my-elements-weight', 'my-elements-weight-' . $region);
659 660
 * @endcode
 *
661 662 663 664
 * 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.
665 666 667
 *
 * @code
 * foreach ($regions as $region) {
668 669
 *   drupal_attach_tabledrag('my-module-table', array(
 *     'action' => 'order',
670
 *     'relationship' => 'sibling',
671
 *     'group' => 'my-elements-weight',
672
 *     'subgroup' => 'my-elements-weight-' . $region,
673
 *   ));
674 675 676 677 678
 * }
 * @endcode
 *
 * In a situation where tree relationships are present, adding multiple
 * subgroups is not necessary, because the table will contain indentations that
679
 * provide enough information about the sibling and parent relationships. See
680 681
 * MenuForm::BuildOverviewForm for an example creating a table
 * containing parent relationships.
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
 * @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.
 *
718
 * @see MenuForm::BuildOverviewForm()
719
 */
720 721
function drupal_attach_tabledrag(&$element, array $options) {
  // Add default values to elements.
722
  $options = $options + [
723 724 725
    'subgroup' => NULL,
    'source' => NULL,
    'hidden' => TRUE,
726
    'limit' => 0,
727
  ];
728

729 730 731 732
  $group = $options['group'];

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

  // If a subgroup or source isn't set, assume it is the same as the group.
735 736
  $target = isset($options['subgroup']) ? $options['subgroup'] : $group;
  $source = isset($options['source']) ? $options['source'] : $target;
737
  $element['#attached']['drupalSettings']['tableDrag'][$options['table_id']][$group][$tabledrag_id] = [
738 739
    'target' => $target,
    'source' => $source,
740 741 742 743
    'relationship' => $options['relationship'],
    'action' => $options['action'],
    'hidden' => $options['hidden'],
    'limit' => $options['limit'],
744
  ];
745

746
  $element['#attached']['library'][] = 'core/drupal.tabledrag';
747 748
}

749
/**
750
 * Deletes old cached JavaScript files and variables.
751 752 753
 *
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Asset\AssetCollectionOptimizerInterface::deleteAll().
754 755
 *
 * @see https://www.drupal.org/node/2317841
756 757
 */
function drupal_clear_js_cache() {
758
  \Drupal::service('asset.js.collection_optimizer')->deleteAll();
759 760
}

761
/**
762
 * Pre-render callback: Renders a link into #markup.
763
 *
764 765
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\Core\Render\Element\Link::preRenderLink().
766
 */
767
function drupal_pre_render_link($element) {
768
  return Link::preRenderLink($element);
769 770
}

771
/**
772
 * Pre-render callback: Collects child links into a single array.
773 774
 *
 * This function can be added as a pre_render callback for a renderable array,
775
 * usually one which will be themed by links.html.twig. It iterates through all
776 777 778 779 780 781 782 783 784 785 786 787 788
 * 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
789
 * $build['links'] = array(
790
 *   '#theme' => 'links__node',
791
 *   '#pre_render' => array('drupal_pre_render_links'),
792 793 794 795
 *   'comment' => array(
 *     '#theme' => 'links__node__comment',
 *     '#links' => array(
 *       // An array of links associated with node comments, suitable for
796
 *       // passing in to links.html.twig.
797 798 799 800 801 802
 *     ),
 *   ),
 *   'statistics' => array(
 *     '#theme' => 'links__node__statistics',
 *     '#links' => array(
 *       // An array of links associated with node statistics, suitable for
803
 *       // passing in to links.html.twig.
804 805 806 807 808 809
 *     ),
 *   ),
 *   'translation' => array(
 *     '#theme' => 'links__node__translation',
 *     '#links' => array(
 *       // An array of links associated with node translation, suitable for
810
 *       // passing in to links.html.twig.
811 812 813 814 815 816 817
 *     ),
 *   ),
 * );
 * @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.
818
 * For example, adding this code to node.html.twig will result in the comment
819 820
 * links being rendered as a single list:
 * @code
821
 * {{ content.links.comment }}
822 823
 * @endcode
 *
824
 * (where a node's content has been transformed into $content before handing
825
 * control to the node.html.twig template).
826 827 828 829 830
 *
 * 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
831
 * {{ content.links }}
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
 * @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) {
847
  $element += ['#links' => [], '#attached' => []];
848
  foreach (Element::children($element) as $key) {
849 850 851
    $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.
852
    if (isset($child['#links']) && empty($child['#printed']) && Element::isVisibleElement($child)) {
853 854 855 856 857
      $element['#links'] += $child['#links'];
      // Mark the child as having been printed already (so that its links
      // cannot be mistakenly rendered twice).
      $child['#printed'] = TRUE;
    }
858 859
    // Merge attachments.
    if (isset($child['#attached'])) {
860
      $element['#attached'] = BubbleableMetadata::mergeAttachments($element['#attached'], $child['#attached']);
861
    }
862 863 864 865
  }
  return $element;
}

866 867 868
/**
 * Renders final HTML given a structured array tree.
 *
869 870
 * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use the
 *   'renderer' service instead.
871
 *
872
 * @see \Drupal\Core\Render\RendererInterface::renderRoot()
873
 * @see https://www.drupal.org/node/2912696
874 875
 */
function drupal_render_root(&$elements) {
876
  return \Drupal::service('renderer')->renderRoot($elements);
877 878
}

879
/**
880 881
 * Renders HTML given a structured array tree.
 *
882 883
 * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use the
 *   'renderer' service instead.
884
 *
885
 * @see \Drupal\Core\Render\RendererInterface::render()
886
 * @see https://www.drupal.org/node/2912696
887 888 889
 */
function drupal_render(&$elements, $is_recursive_call = FALSE) {
  return \Drupal::service('renderer')->render($elements, $is_recursive_call);
890 891 892
}

/**
893
 * Renders children of an element and concatenates them.
894
 *
895
 * @param array $element
896
 *   The structured array whose children shall be rendered.
897 898
 * @param array $children_keys
 *   (optional) If the keys of the element's children are already known, they
899 900
 *   can be passed in to save another run of
 *   \Drupal\Core\Render\Element::children().