common.inc 45.2 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\Gettext\PoItem;
12
use Drupal\Component\Serialization\Json;
13
use Drupal\Component\Utility\Bytes;
14
use Drupal\Component\Utility\Html;
15
use Drupal\Component\Utility\SortArray;
16
use Drupal\Component\Utility\UrlHelper;
17
use Drupal\Core\Cache\Cache;
18
use Drupal\Core\Render\HtmlResponseAttachmentsProcessor;
19
use Drupal\Core\Render\Element\Link;
20 21
use Drupal\Core\Render\Markup;
use Drupal\Core\StringTranslation\TranslatableMarkup;
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\Component\Gettext\PoItem::DELIMITER instead.
131
 */
132
const LOCALE_PLURAL_DELIMITER = PoItem::DELIMITER;
133

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

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

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

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

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

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

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

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

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

    case 'MB':
      return new TranslatableMarkup('@size MB', $args, $options);

    case 'GB':
      return new TranslatableMarkup('@size GB', $args, $options);

    case 'TB':
      return new TranslatableMarkup('@size TB', $args, $options);

    case 'PB':
      return new TranslatableMarkup('@size PB', $args, $options);

    case 'EB':
      return new TranslatableMarkup('@size EB', $args, $options);

    case 'ZB':
      return new TranslatableMarkup('@size ZB', $args, $options);

    case 'YB':
      return new TranslatableMarkup('@size YB', $args, $options);
  }
Dries's avatar
 
Dries committed
294 295
}

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

336 337 338
/**
 * Returns an ISO8601 formatted date based on the given date.
 *
339
 * @param string $date
340
 *   A UNIX timestamp.
341
 *
342 343
 * @return string
 *   An ISO8601 formatted date.
344 345 346 347 348
 *
 * @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
349 350
 */
function date_iso8601($date) {
351
  @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);
352 353 354 355 356
  // 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
357 358 359
/**
 * @} End of "defgroup format".
 */
Dries's avatar
 
Dries committed
360

361
/**
362
 * Formats an attribute string for an HTTP header.
363
 *
364
 * @param array $attributes
365 366
 *   An associative array of attributes such as 'rel'.
 *
367
 * @return string
368 369
 *   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.
370 371 372 373 374 375
 *
 * @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
376
 */
377
function drupal_http_header_attributes(array $attributes = []) {
378
  @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);
379
  return HtmlResponseAttachmentsProcessor::formatHttpHeaderAttributes($attributes);
380 381
}

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

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

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

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

469
/**
470
 * Adds JavaScript to change the state of an element based on another element.
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
 * 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
505
 * conditions, which must be met on that element:
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 535 536 537 538
 * @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),
539
 *     ),
540 541 542 543 544 545 546
 *   ),
 * );
 * @endcode
 *
 * The following states may be applied to an element:
 * - enabled
 * - disabled
547 548
 * - required
 * - optional
549 550 551 552 553 554 555 556
 * - visible
 * - invisible
 * - checked
 * - unchecked
 * - expanded
 * - collapsed
 *
 * The following states may be used in remote conditions:
557 558
 * - empty
 * - filled
559 560
 * - checked
 * - unchecked
561 562
 * - expanded
 * - collapsed
563 564
 * - value
 *
565 566
 * The following states exist for both elements and remote conditions, but are
 * not fully implemented and may not change anything on the element:
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
 * - 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()
591 592
 */
function drupal_process_states(&$elements) {
593
  $elements['#attached']['library'][] = 'core/drupal.states';
594 595 596 597 598
  // 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';
599
  $elements[$key]['data-drupal-states'] = Json::encode($elements['#states']);
600 601
}

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

733 734 735 736
  $group = $options['group'];

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

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

750
  $element['#attached']['library'][] = 'core/drupal.tabledrag';
751 752
}

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

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

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

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

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

/**
897
 * Renders children of an element and concatenates them.
898
 *
899
 * @param array $element
900
 *   The structured array whose children shall be rendered.
901 902
 * @param array $children_keys
 *   (optional) If the keys of the element's children are already known, they
903 904
 *   can be passed in to save another run of
 *   \Drupal\Core\Render\Element::children().
905
 *
906
 * @return string|\Drupal\Component\Render\MarkupInterface
907
 *   The rendered HTML of all children of the element.
908
 *
909 910 911 912
 * @deprecated in Drupal 8.0.x and will be removed before 9.0.0. Avoid early
 *   rendering when possible or loop through the elements and render them as
 *   they are available.
 *
913
 * @see \Drupal\Core\Render\RendererInterface::render()
914
 * @see https://www.drupal.org/node/2912757
915
 */
916
function drupal_render_children(&$element, $children_keys = NULL) {
917
  if ($children_keys === NULL) {
918
    $children_keys = Element::children($element);
919 920 921
  }
  $output = '';
  foreach ($children_keys as $key) {