theme.inc 69.1 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2

3
/**
Dries's avatar
 
Dries committed
4
 * @file
5
 * The theme system, which controls the output of Drupal.
Dries's avatar
 
Dries committed
6 7 8 9
 *
 * The theme system allows for nearly all output of the Drupal system to be
 * customized by user themes.
 */
Dries's avatar
 
Dries committed
10

11
use Drupal\Component\Serialization\Json;
12
use Drupal\Component\Utility\Html;
13
use Drupal\Component\Utility\SafeMarkup;
14
use Drupal\Component\Utility\String;
15
use Drupal\Component\Utility\Unicode;
16
use Drupal\Component\Utility\UrlHelper;
17
use Drupal\Component\Utility\Xss;
18
use Drupal\Core\Asset\AttachedAssets;
19
use Drupal\Core\Config\Config;
20
use Drupal\Core\Config\StorageException;
21
use Drupal\Core\Extension\Extension;
22
use Drupal\Core\Extension\ExtensionNameLengthException;
23
use Drupal\Core\Template\Attribute;
24
use Drupal\Core\Theme\ThemeSettings;
25
use Drupal\Component\Utility\NestedArray;
26
use Drupal\Core\Render\Element;
27
use Symfony\Component\HttpFoundation\Request;
28

29
/**
30
 * @defgroup content_flags Content markers
31
 * @{
32 33 34 35
 * Markers used by mark.html.twig and node_mark() to designate content.
 *
 * @see mark.html.twig
 * @see node_mark()
36
 */
37 38 39 40

/**
 * Mark content as read.
 */
41
const MARK_READ = 0;
42 43 44 45

/**
 * Mark content as being new.
 */
46
const MARK_NEW = 1;
47 48 49 50

/**
 * Mark content as being updated.
 */
51
const MARK_UPDATED = 2;
52

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/**
 * A responsive table class; hide table cell on narrow devices.
 *
 * Indicates that a column has medium priority and thus can be hidden on narrow
 * width devices and shown on medium+ width devices (i.e. tablets and desktops).
 */
const RESPONSIVE_PRIORITY_MEDIUM = 'priority-medium';

/**
 * A responsive table class; only show table cell on wide devices.
 *
 * Indicates that a column has low priority and thus can be hidden on narrow
 * and medium viewports and shown on wide devices (i.e. desktops).
 */
const RESPONSIVE_PRIORITY_LOW = 'priority-low';

69
/**
70
 * @} End of "defgroup content_flags".
71 72
 */

73
/**
74
 * Gets the theme registry.
75
 *
76
 * @param bool $complete
77
 *   Optional boolean to indicate whether to return the complete theme registry
78 79 80 81 82 83 84
 *   array or an instance of the Drupal\Core\Utility\ThemeRegistry class.
 *   If TRUE, the complete theme registry array will be returned. This is useful
 *   if you want to foreach over the whole registry, use array_* functions or
 *   inspect it in a debugger. If FALSE, an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class will be returned, this provides an
 *   ArrayObject which allows it to be accessed with array syntax and isset(),
 *   and should be more lightweight than the full registry. Defaults to TRUE.
85
 *
86
 * @return
87 88
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
89
 */
90
function theme_get_registry($complete = TRUE) {
91
  $theme_registry = \Drupal::service('theme.registry');
92
  if ($complete) {
93
    return $theme_registry->get();
94 95
  }
  else {
96
    return $theme_registry->getRuntime();
97 98 99 100
  }
}

/**
101 102 103 104
 * Forces the system to rebuild the theme registry.
 *
 * This function should be called when modules are added to the system, or when
 * a dynamic system needs to add more theme hooks.
105
 */
106
function drupal_theme_rebuild() {
107
  \Drupal::service('theme.registry')->reset();
108 109
}

110
/**
111
 * Allows themes and/or theme engines to discover overridden theme functions.
112 113 114 115 116 117
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $prefixes
 *   An array of prefixes to test, in reverse order of importance.
 *
118
 * @return $implementations
119 120 121
 *   The functions found, suitable for returning from hook_theme;
 */
function drupal_find_theme_functions($cache, $prefixes) {
122
  $implementations = array();
123 124 125 126
  $functions = get_defined_functions();

  foreach ($cache as $hook => $info) {
    foreach ($prefixes as $prefix) {
127 128 129 130 131 132
      // Find theme functions that implement possible "suggestion" variants of
      // registered theme hooks and add those as new registered theme hooks.
      // The 'pattern' key defines a common prefix that all suggestions must
      // start with. The default is the name of the hook followed by '__'. An
      // 'base hook' key is added to each entry made for a found suggestion,
      // so that common functionality can be implemented for all suggestions of
133
      // the same base hook. To keep things simple, deep hierarchy of
134 135 136 137
      // suggestions is not supported: each suggestion's 'base hook' key
      // refers to a base hook, not to another suggestion, and all suggestions
      // are found using the base hook's pattern, not a pattern from an
      // intermediary suggestion.
138
      $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
139
      if (!isset($info['base hook']) && !empty($pattern)) {
140
        $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
141 142
        if ($matches) {
          foreach ($matches as $match) {
143
            $new_hook = substr($match, strlen($prefix) + 1);
144
            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
145
            $implementations[$new_hook] = array(
146
              'function' => $match,
147
              $arg_name => $info[$arg_name],
148
              'base hook' => $hook,
149 150 151 152
            );
          }
        }
      }
153 154 155
      // Find theme functions that implement registered theme hooks and include
      // that in what is returned so that the registry knows that the theme has
      // this implementation.
156
      if (function_exists($prefix . '_' . $hook)) {
157
        $implementations[$hook] = array(
158
          'function' => $prefix . '_' . $hook,
159 160 161 162 163
        );
      }
    }
  }

164
  return $implementations;
165 166 167
}

/**
168
 * Allows themes and/or theme engines to easily discover overridden templates.
169 170 171 172 173 174 175 176 177
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $extension
 *   The extension that these templates will have.
 * @param $path
 *   The path to search.
 */
function drupal_find_theme_templates($cache, $extension, $path) {
178
  $implementations = array();
179

180 181 182 183
  // Collect paths to all sub-themes grouped by base themes. These will be
  // used for filtering. This allows base themes to have sub-themes in its
  // folder hierarchy without affecting the base themes template discovery.
  $theme_paths = array();
184
  foreach (\Drupal::service('theme_handler')->listInfo() as $theme_info) {
185
    if (!empty($theme_info->base_theme)) {
186
      $theme_paths[$theme_info->base_theme][$theme_info->getName()] = $theme_info->getPath();
187 188 189 190 191 192 193
    }
  }
  foreach ($theme_paths as $basetheme => $subthemes) {
    foreach ($subthemes as $subtheme => $subtheme_path) {
      if (isset($theme_paths[$subtheme])) {
        $theme_paths[$basetheme] = array_merge($theme_paths[$basetheme], $theme_paths[$subtheme]);
      }
194 195
    }
  }
196
  $theme = \Drupal::theme()->getActiveTheme()->getName();
197
  $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
198

199
  // Escape the periods in the extension.
200
  $regex = '/' . str_replace('.', '\.', $extension) . '$/';
201
  // Get a listing of all template files in the path to search.
202
  $files = file_scan_directory($path, $regex, array('key' => 'filename'));
203 204 205 206

  // Find templates that implement registered theme hooks and include that in
  // what is returned so that the registry knows that the theme has this
  // implementation.
207
  foreach ($files as $template => $file) {
208
    // Ignore sub-theme templates for the current theme.
209
    if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
210 211
      continue;
    }
212 213
    // Remove the extension from the filename.
    $template = str_replace($extension, '', $template);
214 215 216 217
    // Transform - in filenames to _ to match function naming scheme
    // for the purposes of searching.
    $hook = strtr($template, '-', '_');
    if (isset($cache[$hook])) {
218
      $implementations[$hook] = array(
219
        'template' => $template,
220
        'path' => dirname($file->uri),
221 222
      );
    }
223 224 225 226

    // Match templates based on the 'template' filename.
    foreach ($cache as $hook => $info) {
      if (isset($info['template'])) {
227
        $template_candidates = array($info['template'], str_replace($info['theme path'] . '/templates/', '', $info['template']));
228 229 230 231 232 233 234 235
        if (in_array($template, $template_candidates)) {
          $implementations[$hook] = array(
            'template' => $template,
            'path' => dirname($file->uri),
          );
        }
      }
    }
236 237
  }

238
  // Find templates that implement possible "suggestion" variants of registered
239
  // theme hooks and add those as new registered theme hooks. See
240 241
  // drupal_find_theme_functions() for more information about suggestions and
  // the use of 'pattern' and 'base hook'.
242 243
  $patterns = array_keys($files);
  foreach ($cache as $hook => $info) {
244
    $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
245
    if (!isset($info['base hook']) && !empty($pattern)) {
246 247
      // Transform _ in pattern to - to match file naming scheme
      // for the purposes of searching.
248
      $pattern = strtr($pattern, '_', '-');
249

250
      $matches = preg_grep('/^' . $pattern . '/', $patterns);
251 252
      if ($matches) {
        foreach ($matches as $match) {
253
          $file = $match;
254 255
          // Remove the extension from the filename.
          $file = str_replace($extension, '', $file);
256 257
          // Put the underscores back in for the hook name and register this
          // pattern.
258
          $arg_name = isset($info['variables']) ? 'variables' : 'render element';
259
          $implementations[strtr($file, '-', '_')] = array(
260
            'template' => $file,
261
            'path' => dirname($files[$match]->uri),
262
            $arg_name => $info[$arg_name],
263
            'base hook' => $hook,
264 265 266 267 268
          );
        }
      }
    }
  }
269
  return $implementations;
270 271
}

Dries's avatar
 
Dries committed
272
/**
273
 * Retrieves a setting for the current theme or for a given theme.
Dries's avatar
 
Dries committed
274
 *
275 276 277 278 279 280
 * The final setting is obtained from the last value found in the following
 * sources:
 * - the saved values from the global theme settings form
 * - the saved values from the theme's settings form
 * To only retrieve the default global theme setting, an empty string should be
 * given for $theme.
Dries's avatar
 
Dries committed
281 282
 *
 * @param $setting_name
283
 *   The name of the setting to be retrieved.
284
 * @param $theme
285 286
 *   The name of a given theme; defaults to the current theme.
 *
Dries's avatar
 
Dries committed
287 288 289
 * @return
 *   The value of the requested setting, NULL if the setting does not exist.
 */
290
function theme_get_setting($setting_name, $theme = NULL) {
291
  /** @var \Drupal\Core\Theme\ThemeSettings[] $cache */
292
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
293

294
  // If no key is given, use the current theme if we can determine it.
295
  if (!isset($theme)) {
296
    $theme = \Drupal::theme()->getActiveTheme()->getName();
297
  }
Dries's avatar
 
Dries committed
298

299
  if (empty($cache[$theme])) {
300 301
    // Create a theme settings object.
    $cache[$theme] = new ThemeSettings($theme);
302 303
    // Get the global settings from configuration.
    $cache[$theme]->setData(\Drupal::config('system.theme.global')->get());
304

305 306
    // Get the values for the theme-specific settings from the .info.yml files
    // of the theme and all its base themes.
307 308
    $themes = \Drupal::service('theme_handler')->listInfo();
    if (isset($themes[$theme])) {
309 310
      $theme_object = $themes[$theme];

311 312 313 314 315 316 317 318
      // Retrieve configured theme-specific settings, if any.
      try {
        if ($theme_settings = \Drupal::config($theme . '.settings')->get()) {
          $cache[$theme]->merge($theme_settings);
        }
      }
      catch (StorageException $e) {
      }
319

320 321 322
      // If the theme does not support a particular feature, override the global
      // setting and set the value to NULL.
      if (!empty($theme_object->info['features'])) {
323
        foreach (_system_default_theme_features() as $feature) {
324
          if (!in_array($feature, $theme_object->info['features'])) {
325
            $cache[$theme]->set('features.' . $feature, NULL);
326 327 328 329
          }
        }
      }

330
      // Generate the path to the logo image.
331 332 333
      if ($cache[$theme]->get('features.logo')) {
        $logo_path = $cache[$theme]->get('logo.path');
        if ($cache[$theme]->get('logo.use_default')) {
334
          $cache[$theme]->set('logo.url', file_create_url($theme_object->getPath() . '/logo.svg'));
335
        }
336 337
        elseif ($logo_path) {
          $cache[$theme]->set('logo.url', file_create_url($logo_path));
338 339
        }
      }
340 341

      // Generate the path to the favicon.
342 343 344
      if ($cache[$theme]->get('features.favicon')) {
        $favicon_path = $cache[$theme]->get('favicon.path');
        if ($cache[$theme]->get('favicon.use_default')) {
345
          if (file_exists($favicon = $theme_object->getPath() . '/favicon.ico')) {
346
            $cache[$theme]->set('favicon.url', file_create_url($favicon));
347 348
          }
          else {
349
            $cache[$theme]->set('favicon.url', file_create_url('core/misc/favicon.ico'));
350 351
          }
        }
352 353
        elseif ($favicon_path) {
          $cache[$theme]->set('favicon.url', file_create_url($favicon_path));
354 355
        }
        else {
356
          $cache[$theme]->set('features.favicon', FALSE);
357
        }
358
      }
359
    }
Dries's avatar
 
Dries committed
360 361
  }

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  return $cache[$theme]->get($setting_name);
}

/**
 * Converts theme settings to configuration.
 *
 * @see system_theme_settings_submit()
 *
 * @param array $theme_settings
 *   An array of theme settings from system setting form or a Drupal 7 variable.
 * @param Config $config
 *   The configuration object to update.
 *
 * @return
 *   The Config object with updated data.
 */
function theme_settings_convert_to_config(array $theme_settings, Config $config) {
  foreach ($theme_settings as $key => $value) {
    if ($key == 'default_logo') {
      $config->set('logo.use_default', $value);
    }
    else if ($key == 'logo_path') {
      $config->set('logo.path', $value);
    }
    else if ($key == 'default_favicon') {
      $config->set('favicon.use_default', $value);
    }
    else if ($key == 'favicon_path') {
      $config->set('favicon.path', $value);
    }
    else if ($key == 'favicon_mimetype') {
      $config->set('favicon.mimetype', $value);
    }
    else if (substr($key, 0, 7) == 'toggle_') {
396
      $config->set('features.' . Unicode::substr($key, 7), $value);
397 398 399 400 401 402
    }
    else if (!in_array($key, array('theme', 'logo_upload'))) {
      $config->set($key, $value);
    }
  }
  return $config;
Dries's avatar
 
Dries committed
403 404
}

405
/**
406
 * @addtogroup themeable
407 408
 * @{
 */
409

410
/**
411 412 413
 * Prepares variables for time templates.
 *
 * Default template: time.html.twig.
414 415
 *
 * @param array $variables
416
 *   An associative array possibly containing:
417 418 419
 *   - attributes['timestamp']:
 *   - timestamp:
 *   - text:
420
 */
421
function template_preprocess_time(&$variables) {
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
  // Format the 'datetime' attribute based on the timestamp.
  // @see http://www.w3.org/TR/html5-author/the-time-element.html#attr-time-datetime
  if (!isset($variables['attributes']['datetime']) && isset($variables['timestamp'])) {
    $variables['attributes']['datetime'] = format_date($variables['timestamp'], 'html_datetime', '', 'UTC');
  }

  // If no text was provided, try to auto-generate it.
  if (!isset($variables['text'])) {
    // Format and use a human-readable version of the timestamp, if any.
    if (isset($variables['timestamp'])) {
      $variables['text'] = format_date($variables['timestamp']);
      $variables['html'] = FALSE;
    }
    // Otherwise, use the literal datetime attribute.
    elseif (isset($variables['attributes']['datetime'])) {
      $variables['text'] = $variables['attributes']['datetime'];
      $variables['html'] = FALSE;
    }
  }
}

443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 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
/**
 * Prepares variables for datetime form element templates.
 *
 * The datetime form element serves as a wrapper around the date element type,
 * which creates a date and a time component for a date.
 *
 * Default template: datetime-form.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - element: An associative array containing the properties of the element.
 *     Properties used: #title, #value, #options, #description, #required,
 *     #attributes.
 *
 * @see form_process_datetime()
 */
function template_preprocess_datetime_form(&$variables) {
  $element = $variables['element'];

  $variables['attributes'] = array();
  if (isset($element['#id'])) {
    $variables['attributes']['id'] = $element['#id'];
  }
  if (!empty($element['#attributes']['class'])) {
    $variables['attributes']['class'] = (array) $element['#attributes']['class'];
  }

  $variables['content'] = $element;
}

/**
 * Prepares variables for datetime form wrapper templates.
 *
 * Default template: datetime-wrapper.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - element: An associative array containing the properties of the element.
 *     Properties used: #title, #children, #required, #attributes.
 */
function template_preprocess_datetime_wrapper(&$variables) {
  $element = $variables['element'];

  if (!empty($element['#title'])) {
    $variables['title'] = $element['#title'];
  }

  if (!empty($element['#description'])) {
    $variables['description'] = $element['#description'];
  }

494
  $variables['required'] = FALSE;
495 496 497
  // For required datetime fields a 'form-required' class is appended to the
  // label attributes.
  if (!empty($element['#required'])) {
498
    $variables['required'] = TRUE;
499 500 501 502
  }
  $variables['content'] = $element['#children'];
}

Dries's avatar
 
Dries committed
503
/**
504
 * Prepares variables for status message templates.
Dries's avatar
 
Dries committed
505
 *
506
 * Default template: status-messages.html.twig.
507
 *
508
 * @param array $variables
509
 *   An associative array containing:
510 511
 *   - display: (optional) May have a value of 'status' or 'error' when only
 *     displaying messages of that specific type.
Dries's avatar
 
Dries committed
512
 */
513 514 515
function template_preprocess_status_messages(&$variables) {
  $variables['message_list'] = drupal_get_messages($variables['display']);
  $variables['status_headings'] = array(
516 517 518 519
    'status' => t('Status message'),
    'error' => t('Error message'),
    'warning' => t('Warning message'),
  );
Dries's avatar
 
Dries committed
520 521
}

Dries's avatar
 
Dries committed
522
/**
523
 * Prepares variables for links templates.
524
 *
525 526 527
 * Default template: links.html.twig.
 *
 * @param array $variables
528
 *   An associative array containing:
529
 *   - links: An associative array of links to be themed. The key for each link
530
 *     is used as its CSS class. Each link should be itself an array, with the
531 532
 *     following elements:
 *     - title: The link text.
533 534
 *     - url: (optional) The url object to link to. If omitted, no a tag is
 *       printed out.
535 536 537
 *     - html: (optional) Whether or not 'title' is HTML. If set, the title
 *       will not be passed through
 *       \Drupal\Component\Utility\String::checkPlain().
538 539
 *     - attributes: (optional) Attributes for the anchor, or for the <span>
 *       tag used in its place if no 'href' is supplied. If element 'class' is
540
 *       included, it must be an array of one or more class names.
541 542
 *     If the 'href' element is supplied, the entire link array is passed to
 *     l() as its $options parameter.
543 544
 *   - attributes: A keyed array of attributes for the UL containing the
 *     list of links.
545
 *   - set_active_class: (optional) Whether each link should compare the
546
 *     route_name + route_parameters or href (path), language and query options
547 548 549 550
 *     to the current URL, to determine whether the link is "active". If so, an
 *     "active" class will be applied to the list item containing the link, as
 *     well as the link itself. It is important to use this sparingly since it
 *     is usually unnecessary and requires extra processing.
551 552 553 554 555
 *     For anonymous users, the "active" class will be calculated on the server,
 *     because most sites serve each anonymous user the same cached page anyway.
 *     For authenticated users, the "active" class will be calculated on the
 *     client (through JavaScript), only data- attributes are added to list
 *     items and contained links, to prevent breaking the render cache. The
556
 *     JavaScript is added in system_page_attachments().
557 558 559
 *   - heading: (optional) A heading to precede the links. May be an
 *     associative array or a string. If it's an array, it can have the
 *     following elements:
560 561
 *     - text: The heading text.
 *     - level: The heading level (e.g. 'h2', 'h3').
562
 *     - attributes: (optional) An array of the CSS attributes for the heading.
563
 *     When using a string it will be used as the text of the heading and the
564 565
 *     level will default to 'h2'. Headings should be used on navigation menus
 *     and any list of links that consistently appears on multiple pages. To
566
 *     make the heading invisible use the 'visually-hidden' CSS class. Do not
567 568
 *     use 'display:none', which removes it from screen readers and assistive
 *     technology. Headings allow screen reader and keyboard only users to
569 570 571
 *     navigate to or skip the links. See
 *     http://juicystudio.com/article/screen-readers-display-none.php and
 *     http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
572
 *
573 574
 * Unfortunately links templates duplicate the "active" class handling of l()
 * and LinkGenerator::generate() because it needs to be able to set the "active"
575 576 577 578 579 580 581
 * class not on the links themselves ("a" tags), but on the list items ("li"
 * tags) that contain the links. This is necessary for CSS to be able to style
 * list items differently when the link is active, since CSS does not yet allow
 * one to style list items only if it contains a certain element with a certain
 * class. I.e. we cannot yet convert this jQuery selector to a CSS selector:
 *   jQuery('li:has("a.active")')
 *
582
 * @see \Drupal\Core\Utility\LinkGenerator
583
 * @see \Drupal\Core\Utility\LinkGenerator::generate()
584
 * @see system_page_attachments()
Dries's avatar
 
Dries committed
585
 */
586
function template_preprocess_links(&$variables) {
587
  $links = $variables['links'];
588
  $heading = &$variables['heading'];
589

590 591
  if (!empty($links)) {
    // Prepend the heading to the list, if any.
592
    if (!empty($heading)) {
593
      // Convert a string heading into an array, using a H2 tag by default.
594
      if (is_string($heading)) {
595
        $heading = array('text' => $heading);
596
      }
597 598 599 600 601
      // Merge in default array properties into $heading.
      $heading += array(
        'level' => 'h2',
        'attributes' => array(),
      );
602 603 604
      // Convert the attributes array into an Attribute object.
      $heading['attributes'] = new Attribute($heading['attributes']);
      $heading['text'] = String::checkPlain($heading['text']);
605 606
    }

607
    $variables['links'] = array();
608
    foreach ($links as $key => $link) {
609
      $item = array();
610
      $link += array(
611
        'ajax' => NULL,
612
        'url' => NULL,
613 614
      );

615
      $li_attributes = array();
616
      $keys = ['title', 'url'];
617 618
      $link_element = array(
        '#type' => 'link',
619
        '#title' => $link['title'],
620
        '#options' => array_diff_key($link, array_combine($keys, $keys)),
621
        '#url' => $link['url'],
622
        '#ajax' => $link['ajax'],
623 624
      );

625 626
      // Handle links and ensure that the active class is added on the LIs, but
      // only if the 'set_active_class' option is not empty.
627
      if (isset($link['url'])) {
628
        if (!empty($variables['set_active_class'])) {
629

630 631
          // Also enable set_active_class for the contained link.
          $link_element['#options']['set_active_class'] = TRUE;
632

633
          if (!empty($link['language'])) {
634
            $li_attributes['hreflang'] = $link['language']->getId();
635 636 637 638 639 640 641 642 643 644
          }

          // Add a "data-drupal-link-query" attribute to let the
          // drupal.active-link library know the query in a standardized manner.
          if (!empty($link['query'])) {
            $query = $link['query'];
            ksort($query);
            $li_attributes['data-drupal-link-query'] = Json::encode($query);
          }

645 646 647 648 649 650 651 652 653
          /** @var \Drupal\Core\Url $url */
          $url = $link['url'];
          if ($url->isRouted()) {
            // Add a "data-drupal-link-system-path" attribute to let the
            // drupal.active-link library know the path in a standardized manner.
            $system_path = $url->getInternalPath();
            // @todo System path is deprecated - use the route name and parameters.
            // Special case for the front page.
            $li_attributes['data-drupal-link-system-path'] = $system_path == '' ? '<front>' : $system_path;
654
          }
655
        }
656

657
        $item['link'] = $link_element;
658
      }
659

660
      // Handle title-only text items.
661 662
      $text = (!empty($link['html']) ? $link['title'] : String::checkPlain($link['title']));
      $item['text'] = $text;
663 664
      if (isset($link['attributes'])) {
        $item['text_attributes'] = new Attribute($link['attributes']);
665
      }
666

667 668
      // Handle list item attributes.
      $item['attributes'] = new Attribute($li_attributes);
669

670
      // Add the item to the list of links.
671
      $variables['links'][$key] = $item;
672
    }
673
  }
Dries's avatar
 
Dries committed
674
}
Dries's avatar
 
Dries committed
675

Dries's avatar
 
Dries committed
676
/**
677
 * Prepares variables for image templates.
Dries's avatar
 
Dries committed
678
 *
679 680 681
 * Default template: image.html.twig.
 *
 * @param array $variables
682
 *   An associative array containing:
683
 *   - uri: Either the path of the image file (relative to base_path()) or a
684
 *     full URL.
685 686
 *   - width: The width of the image (if known).
 *   - height: The height of the image (if known).
687 688 689 690 691
 *   - alt: The alternative text for text-based browsers. HTML 4 and XHTML 1.0
 *     always require an alt attribute. The HTML 5 draft allows the alt
 *     attribute to be omitted in some cases. Therefore, this variable defaults
 *     to an empty string, but can be set to NULL for the attribute to be
 *     omitted. Usually, neither omission nor an empty string satisfies
692
 *     accessibility requirements, so it is strongly encouraged for code
693
 *     calling _theme('image') to pass a meaningful value for this variable.
694 695 696
 *     - http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8
 *     - http://www.w3.org/TR/xhtml1/dtds.html
 *     - http://dev.w3.org/html5/spec/Overview.html#alt
697 698 699
 *   - title: The title text is displayed when the image is hovered in some
 *     popular browsers.
 *   - attributes: Associative array of attributes to be placed in the img tag.
700
 *   - srcset: Array of multiple URIs and sizes/multipliers.
701 702
 *   - sizes: The sizes attribute for viewport-based selection of images.
 *     - http://www.whatwg.org/specs/web-apps/current-work/multipage/embedded-content.html#introduction-3:viewport-based-selection-2
Dries's avatar
 
Dries committed
703
 */
704
function template_preprocess_image(&$variables) {
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  if (!empty($variables['uri'])) {
    $variables['attributes']['src'] = file_create_url($variables['uri']);
  }
  // Generate a srcset attribute conforming to the spec at
  // http://www.w3.org/html/wg/drafts/html/master/embedded-content.html#attr-img-srcset
  if (!empty($variables['srcset'])) {
    $srcset = array();
    foreach ($variables['srcset'] as $src) {
      // URI is mandatory.
      $source = file_create_url($src['uri']);
      if (isset($src['width']) && !empty($src['width'])) {
        $source .= ' ' . $src['width'];
      }
      elseif (isset($src['multiplier']) && !empty($src['multiplier'])) {
        $source .= ' ' . $src['multiplier'];
      }
      $srcset[] = $source;
    }
    $variables['attributes']['srcset'] = implode(', ', $srcset);
  }
725

726
  foreach (array('width', 'height', 'alt', 'title', 'sizes') as $key) {
727
    if (isset($variables[$key])) {
728 729 730 731 732
      // If the property has already been defined in the attributes,
      // do not override, including NULL.
      if (array_key_exists($key, $variables['attributes'])) {
        continue;
      }
733
      $variables['attributes'][$key] = $variables[$key];
734
    }
Dries's avatar
 
Dries committed
735
  }
Dries's avatar
 
Dries committed
736
}
Dries's avatar
 
Dries committed
737

Dries's avatar
 
Dries committed
738
/**
739
 * Prepares variables for table templates.
740
 *
741 742 743
 * Default template: table.html.twig.
 *
 * @param array $variables
744 745 746 747
 *   An associative array containing:
 *   - header: An array containing the table headers. Each element of the array
 *     can be either a localized string or an associative array with the
 *     following keys:
748 749
 *     - data: The localized title of the table column.
 *     - field: The database field represented in the table column (required
750
 *       if user is to be able to sort on this column).
751 752 753 754 755 756 757 758 759 760 761
 *     - sort: A default sort order for this column ("asc" or "desc"). Only
 *       one column should be given a default sort order because table sorting
 *       only applies to one column at a time.
 *     - class: An array of values for the 'class' attribute. In particular,
 *       the least important columns that can be hidden on narrow and medium
 *       width screens should have a 'priority-low' class, referenced with the
 *       RESPONSIVE_PRIORITY_LOW constant. Columns that should be shown on
 *       medium+ wide screens should be marked up with a class of
 *       'priority-medium', referenced by with the RESPONSIVE_PRIORITY_MEDIUM
 *       constant. Themes may hide columns with one of these two classes on
 *       narrow viewports to save horizontal space.
762 763 764 765
 *     - Any HTML attributes, such as "colspan", to apply to the column header
 *       cell.
 *   - rows: An array of table rows. Every row is an array of cells, or an
 *     associative array with the following keys:
766
 *     - data: An array of cells.
767
 *     - Any HTML attributes, such as "class", to apply to the table row.
768
 *     - no_striping: A Boolean indicating that the row should receive no
769
 *       'even / odd' styling. Defaults to FALSE.
770 771
 *     Each cell can be either a string or an associative array with the
 *     following keys:
772 773
 *     - data: The string to display in the table cell.
 *     - header: Indicates this cell is a header.
774 775
 *     - Any HTML attributes, such as "colspan", to apply to the table cell.
 *     Here's an example for $rows:
776
 *     @code
777 778
 *     $rows = array(
 *       // Simple row
779
 *       array(
780
 *         'Cell 1', 'Cell 2', 'Cell 3'
781
 *       ),
782 783 784
 *       // Row with attributes on the row and some of its cells.
 *       array(
 *         'data' => array('Cell 1', array('data' => 'Cell 2', 'colspan' => 2)), 'class' => array('funky')
785
 *       ),
786
 *     );
787
 *     @endcode
788 789
 *   - footer: An array of table rows which will be printed within a <tfoot>
 *     tag, in the same format as the rows element (see above).
790 791 792 793 794 795 796 797 798 799 800
 *   - attributes: An array of HTML attributes to apply to the table tag.
 *   - caption: A localized string to use for the <caption> tag.
 *   - colgroups: An array of column groups. Each element of the array can be
 *     either:
 *     - An array of columns, each of which is an associative array of HTML
 *       attributes applied to the COL element.
 *     - An array of attributes applied to the COLGROUP element, which must
 *       include a "data" attribute. To add attributes to COL elements, set the
 *       "data" attribute with an array of columns, each of which is an
 *       associative array of HTML attributes.
 *     Here's an example for $colgroup:
801
 *     @code
802 803 804
 *     $colgroup = array(
 *       // COLGROUP with one COL element.
 *       array(
805
 *         array(
806
 *           'class' => array('funky'), // Attribute for the COL element.
807 808
 *         ),
 *       ),
809 810 811 812 813 814 815 816 817 818
 *       // Colgroup with attributes and inner COL elements.
 *       array(
 *         'data' => array(
 *           array(
 *             'class' => array('funky'), // Attribute for the COL element.
 *           ),
 *         ),
 *         'class' => array('jazzy'), // Attribute for the COLGROUP element.
 *       ),
 *     );
819
 *     @endcode
820 821 822 823
 *     These optional tags are used to group and set properties on columns
 *     within a table. For example, one may easily group three columns and
 *     apply same background style to all.
 *   - sticky: Use a "sticky" table header.
824 825
 *   - empty: The message to display in an extra row if table does not have any
 *     rows.
Dries's avatar
 
Dries committed
826
 */
827 828 829
function template_preprocess_table(&$variables) {
  $is_sticky = !empty($variables['sticky']);
  $is_responsive = !empty($variables['responsive']);
830

831
  // Format the table columns:
832 833
  if (!empty($variables['colgroups'])) {
    foreach ($variables['colgroups'] as &$colgroup) {
834 835
      // Check if we're dealing with a simple or complex column
      if (isset($colgroup['data'])) {
836 837 838
        $cols = $colgroup['data'];
        unset($colgroup['data']);
        $colgroup_attributes = $colgroup;
839 840 841
      }
      else {
        $cols = $colgroup;
842
        $colgroup_attributes = array();
843
      }
844 845 846 847 848 849 850 851
      $colgroup = array();
      $colgroup['attributes'] = new Attribute($colgroup_attributes);
      $colgroup['cols'] = array();

      // Build columns.
      if (is_array($cols) && !empty($cols)) {
        foreach ($cols as $col_key => $col) {
          $colgroup['cols'][$col_key]['attributes'] = new Attribute($col);
852 853 854 855 856
        }
      }
    }
  }

857 858 859
  // Build an associative array of responsive classes keyed by column.
  $responsive_classes = array();

860
  // Format the table header:
861
  $ts = array();
862
  $header_columns = 0;
863 864 865
  if (!empty($variables['header'])) {
    $ts = tablesort_init($variables['header']);

866 867 868
    // Use a separate index with responsive classes as headers
    // may be associative.
    $responsive_index = -1;
869
    foreach ($variables['header'] as $col_key => $cell) {
870 871 872
      // Increase the responsive index.
      $responsive_index++;

873
      if (!is_array($cell)) {
874
        $header_columns++;
875
        $cell_content = $cell;
876
        $cell_attributes = new Attribute();
877 878 879
        $is_header = TRUE;
      }
      else {
880 881 882 883 884 885
        if (isset($cell['colspan'])) {
          $header_columns += $cell['colspan'];
        }
        else {
          $header_columns++;
        }
886 887 888 889
        $cell_content = '';
        if (isset($cell['data'])) {
          $cell_content = $cell['data'];
          unset($cell['data']);
890
        }
891 892 893 894 895 896 897 898 899 900
        // Flag the cell as a header or not and remove the flag.
        $is_header = isset($cell['header']) ? $cell['header'] : TRUE;
        unset($cell['header']);

        // Track responsive classes for each column as needed. Only the header
        // cells for a column are marked up with the responsive classes by a
        // module developer or themer. The responsive classes on the header cells
        // must be transferred to the content cells.
        if (!empty($cell['class']) && is_array($cell['class'])) {
          if (in_array(RESPONSIVE_PRIORITY_MEDIUM, $cell['class'])) {
901
            $responsive_classes[$responsive_index] = RESPONSIVE_PRIORITY_MEDIUM;
902 903
          }
          elseif (in_array(RESPONSIVE_PRIORITY_LOW, $cell['class'])) {
904
            $responsive_classes[$responsive_index] = RESPONSIVE_PRIORITY_LOW;
905
          }
906
        }
907 908 909 910 911

        if (is_array($cell_content)) {
          $cell_content = drupal_render($cell_content);
        }

912
        tablesort_header($cell_content, $cell, $variables['header'], $ts);
913 914 915

        // tablesort_header() removes the 'sort' and 'field' keys.
        $cell_attributes = new Attribute($cell);
916
      }
917 918 919 920
      $variables['header'][$col_key] = array();
      $variables['header'][$col_key]['tag'] = $is_header ? 'th' : 'td';
      $variables['header'][$col_key]['attributes'] = $cell_attributes;
      $variables['header'][$col_key]['content'] = $cell_content;
Dries's avatar
 
Dries committed
921
    }
922
  }
923
  $variables['header_columns'] = $header_columns;
Dries's avatar
 
Dries committed
924

925 926 927 928 929
  // Rows and footer have the same structure.
  $sections = array('rows' , 'footer');
  foreach ($sections as $section) {
    if (!empty($variables[$section])) {
      foreach ($variables[$section] as $row_key => $row) {
930
        $cells = $row;
931
        $row_attributes = array();
932

933 934 935
        // Check if we're dealing with a simple or complex row
        if (isset($row['data'])) {
          $cells = $row['data'];
936
          $variables['no_striping'] = isset($row['no_striping']) ? $row['no_striping'] : FALSE;
937

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
          // Set the attributes array and exclude 'data' and 'no_striping'.
          $row_attributes = $row;
          unset($row_attributes['data']);
          unset($row_attributes['no_striping']);
        }

        // Build row.
        $variables[$section][$row_key] = array();
        $variables[$section][$row_key]['attributes'] = new Attribute($row_attributes);
        $variables[$section][$row_key]['cells'] = array();
        if (!empty($cells)) {
          // Reset the responsive index.
          $responsive_index = -1;
          foreach ($cells as $col_key => $cell) {
            // Increase the responsive index.
            $responsive_index++;

            if (!is_array($cell)) {
              $cell_content = $cell;
              $cell_attributes = array();
              $is_header = FALSE;
959
            }
960 961 962 963 964 965
            else {
              $cell_content = '';
              if (isset($cell['data'])) {
                $cell_content = $cell['data'];
                unset($cell['data']);
              }
966

967 968 969
              // Flag the cell as a header or not and remove the flag.
              $is_header = !empty($cell['header']);
              unset($cell['header']);
970

971 972 973 974 975
              $cell_attributes = $cell;

              if (is_array($cell_content)) {
                $cell_content = drupal_render($cell_content);
              }
976
            }
977
            // Active table sort information.
978
            if (isset($variables['header'][$col_key]['data']) && $variables['header'][$col_key]['data'] == $ts['name'] && !empty($variables['header'][$col_key]['field'])) {
979
              $variables[$section][$row_key]['cells'][$col_key]['active_table_sort'] = TRUE;
980 981 982 983 984 985 986 987 988
            }
            // Copy RESPONSIVE_PRIORITY_LOW/RESPONSIVE_PRIORITY_MEDIUM
            // class from header to cell as needed.
            if (isset($responsive_classes[$responsive_index])) {
              $cell_attributes['class'][] = $responsive_classes[$responsive_index];
            }
            $variables[$section][$row_key]['cells'][$col_key]['tag'] = $is_header ? 'th' : 'td';
            $variables[$section][$row_key]['cells'][$col_key]['attributes'] = new Attribute($cell_attributes);
            $variables[$section][$row_key]['cells'][$col_key]['content'] = $cell_content;
989
          }
990
        }
Dries's avatar
 
Dries committed
991 992 993
      }
    }
  }
994 995 996
  if (empty($variables['no_striping'])) {
    $variables['attributes']['data-striping'] = 1;
  }
Dries's avatar
 
Dries committed
997 998
}

999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
/**
 * Prepares variables for tablesort indicator templates.
 *
 * Default template: tablesort-indicator.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - style: Set to either 'asc' or 'desc'. This determines which icon to show.
 */
function template_preprocess_tablesort_indicator(&$variables) {
  // Provide the image attributes for an ascending or descending image.
  if ($variables['style'] == 'asc') {
    $variables['arrow_asc'] = file_create_url('core/misc/arrow-asc.png');
  }
  else {
    $variables['arrow_desc'] = file_create_url('core/misc/arrow-desc.png');
  }
}

1018
/**
1019 1020 1021
 * Prepares variables for item list templates.
 *
 * Default template: item-list.html.twig.
1022 1023
 *
 * @param array $variables
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
 *   An associative array containing:
 *   - items: An array of items to be displayed in the list. Each item can be
 *     either a string or a render array. If #type, #theme, or #markup
 *     properties are not specified for child render arrays, they will be
 *     inherited from the parent list, allowing callers to specify larger
 *     nested lists without having to explicitly specify and repeat the
 *     render properties for all nested child lists.
 *   - title: A title to be prepended to the list.
 *   - list_type: The type of list to return (e.g. "ul", "ol").
 *
 * @see http://drupal.org/node/1842756
1035 1036 1037
 */
function template_preprocess_item_list(&$variables) {
  foreach ($variables['items'] as &$item) {
1038
    $attributes = array();
1039 1040
    // If the item value is an array, then it is a render array.
    if (is_array($item)) {
1041 1042 1043 1044
      // List items support attributes via the '#wrapper_attributes' property.
      if (isset($item['#wrapper_attributes'])) {
        $attributes = $item['#wrapper_attributes'];
      }
1045 1046 1047 1048
      // Determine whether there are any child elements in the item that are not
      // fully-specified render arrays. If there are any, then the child
      // elements present nested lists and we automatically inherit the render
      // array properties of the current list to them.
1049
      foreach (Element::children($item) as $key) {
1050 1051 1052 1053
        $child = &$item[$key];
        // If this child element does not specify how it can be rendered, then
        // we need to inherit the render properties of the current list.
        if (!isset($child['#type']) && !isset($child['#theme']) && !isset($child['#markup'])) {