theme.inc 67.8 KB
Newer Older
1
<?php
2

3
/**
4
 * @file
5
 * The theme system, which controls the output of Drupal.
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\Unicode;
15
use Drupal\Component\Utility\UrlHelper;
16
use Drupal\Component\Utility\Xss;
17
use Drupal\Core\Asset\AttachedAssets;
18
use Drupal\Core\Config\Config;
19
use Drupal\Core\Config\StorageException;
20
use Drupal\Core\Extension\Extension;
21
use Drupal\Core\Extension\ExtensionNameLengthException;
22
use Drupal\Core\Template\Attribute;
23
use Drupal\Core\Theme\ThemeSettings;
24
use Drupal\Component\Utility\NestedArray;
25
use Drupal\Core\Render\Element;
26
use Symfony\Component\HttpFoundation\Request;
27

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

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

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

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

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
/**
 * 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';

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

72
/**
73
 * Gets the theme registry.
74
 *
75
 * @param bool $complete
76
 *   Optional boolean to indicate whether to return the complete theme registry
77 78 79 80 81 82 83
 *   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.
84
 *
85
 * @return
86 87
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
88
 */
89
function theme_get_registry($complete = TRUE) {
90
  $theme_registry = \Drupal::service('theme.registry');
91
  if ($complete) {
92
    return $theme_registry->get();
93 94
  }
  else {
95
    return $theme_registry->getRuntime();
96 97 98 99
  }
}

/**
100 101 102 103
 * 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.
104
 */
105
function drupal_theme_rebuild() {
106
  \Drupal::service('theme.registry')->reset();
107 108
}

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

  foreach ($cache as $hook => $info) {
    foreach ($prefixes as $prefix) {
126 127 128 129 130 131
      // 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
132
      // the same base hook. To keep things simple, deep hierarchy of
133 134 135 136
      // 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.
137
      $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
138 139 140 141
      // Grep only the functions which are within the prefix group.
      list($first_prefix,) = explode('_', $prefix, 2);
      if (!isset($info['base hook']) && !empty($pattern) && isset($grouped_functions[$first_prefix])) {
        $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $grouped_functions[$first_prefix]);
142 143
        if ($matches) {
          foreach ($matches as $match) {
144
            $new_hook = substr($match, strlen($prefix) + 1);
145
            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
146
            $implementations[$new_hook] = array(
147
              'function' => $match,
148
              $arg_name => $info[$arg_name],
149
              'base hook' => $hook,
150 151 152 153
            );
          }
        }
      }
154 155 156
      // 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.
157
      if (function_exists($prefix . '_' . $hook)) {
158
        $implementations[$hook] = array(
159
          'function' => $prefix . '_' . $hook,
160 161 162 163 164
        );
      }
    }
  }

165
  return $implementations;
166 167
}

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/**
 * Group all user functions by word before first underscore.
 *
 * @return array
 *   Functions grouped by the first prefix.
 */
function drupal_group_functions_by_prefix() {
  $functions = get_defined_functions();

  $grouped_functions = [];
  // Splitting user defined functions into groups by the first prefix.
  foreach ($functions['user'] as $function) {
    list($first_prefix,) = explode('_', $function, 2);
    $grouped_functions[$first_prefix][] = $function;
  }

  return $grouped_functions;
}

187
/**
188
 * Allows themes and/or theme engines to easily discover overridden templates.
189 190 191 192 193 194 195 196 197
 *
 * @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) {
198
  $implementations = array();
199

200 201 202 203
  // 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();
204
  foreach (\Drupal::service('theme_handler')->listInfo() as $theme_info) {
205
    if (!empty($theme_info->base_theme)) {
206
      $theme_paths[$theme_info->base_theme][$theme_info->getName()] = $theme_info->getPath();
207 208 209 210 211 212 213
    }
  }
  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]);
      }
214 215
    }
  }
216
  $theme = \Drupal::theme()->getActiveTheme()->getName();
217
  $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
218

219
  // Escape the periods in the extension.
220
  $regex = '/' . str_replace('.', '\.', $extension) . '$/';
221
  // Get a listing of all template files in the path to search.
222
  $files = file_scan_directory($path, $regex, array('key' => 'filename'));
223 224 225 226

  // 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.
227
  foreach ($files as $template => $file) {
228
    // Ignore sub-theme templates for the current theme.
229
    if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
230 231
      continue;
    }
232 233
    // Remove the extension from the filename.
    $template = str_replace($extension, '', $template);
234 235 236 237
    // Transform - in filenames to _ to match function naming scheme
    // for the purposes of searching.
    $hook = strtr($template, '-', '_');
    if (isset($cache[$hook])) {
238
      $implementations[$hook] = array(
239
        'template' => $template,
240
        'path' => dirname($file->uri),
241 242
      );
    }
243 244 245 246

    // Match templates based on the 'template' filename.
    foreach ($cache as $hook => $info) {
      if (isset($info['template'])) {
247
        $template_candidates = array($info['template'], str_replace($info['theme path'] . '/templates/', '', $info['template']));
248 249 250 251 252 253 254 255
        if (in_array($template, $template_candidates)) {
          $implementations[$hook] = array(
            'template' => $template,
            'path' => dirname($file->uri),
          );
        }
      }
    }
256 257
  }

258
  // Find templates that implement possible "suggestion" variants of registered
259
  // theme hooks and add those as new registered theme hooks. See
260 261
  // drupal_find_theme_functions() for more information about suggestions and
  // the use of 'pattern' and 'base hook'.
262 263
  $patterns = array_keys($files);
  foreach ($cache as $hook => $info) {
264
    $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
265
    if (!isset($info['base hook']) && !empty($pattern)) {
266 267
      // Transform _ in pattern to - to match file naming scheme
      // for the purposes of searching.
268
      $pattern = strtr($pattern, '_', '-');
269

270
      $matches = preg_grep('/^' . $pattern . '/', $patterns);
271 272
      if ($matches) {
        foreach ($matches as $match) {
273
          $file = $match;
274 275
          // Remove the extension from the filename.
          $file = str_replace($extension, '', $file);
276 277
          // Put the underscores back in for the hook name and register this
          // pattern.
278
          $arg_name = isset($info['variables']) ? 'variables' : 'render element';
279
          $implementations[strtr($file, '-', '_')] = array(
280
            'template' => $file,
281
            'path' => dirname($files[$match]->uri),
282
            $arg_name => $info[$arg_name],
283
            'base hook' => $hook,
284 285 286 287 288
          );
        }
      }
    }
  }
289
  return $implementations;
290 291
}

292
/**
293
 * Retrieves a setting for the current theme or for a given theme.
294
 *
295 296 297 298 299 300
 * 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.
301 302
 *
 * @param $setting_name
303
 *   The name of the setting to be retrieved.
304
 * @param $theme
305 306
 *   The name of a given theme; defaults to the current theme.
 *
307 308 309
 * @return
 *   The value of the requested setting, NULL if the setting does not exist.
 */
310
function theme_get_setting($setting_name, $theme = NULL) {
311
  /** @var \Drupal\Core\Theme\ThemeSettings[] $cache */
312
  $cache = &drupal_static(__FUNCTION__, array());
313

314
  // If no key is given, use the current theme if we can determine it.
315
  if (!isset($theme)) {
316
    $theme = \Drupal::theme()->getActiveTheme()->getName();
317
  }
318

319
  if (empty($cache[$theme])) {
320 321
    // Create a theme settings object.
    $cache[$theme] = new ThemeSettings($theme);
322 323
    // Get the global settings from configuration.
    $cache[$theme]->setData(\Drupal::config('system.theme.global')->get());
324

325 326
    // Get the values for the theme-specific settings from the .info.yml files
    // of the theme and all its base themes.
327 328
    $themes = \Drupal::service('theme_handler')->listInfo();
    if (isset($themes[$theme])) {
329 330
      $theme_object = $themes[$theme];

331 332 333 334 335 336 337 338
      // Retrieve configured theme-specific settings, if any.
      try {
        if ($theme_settings = \Drupal::config($theme . '.settings')->get()) {
          $cache[$theme]->merge($theme_settings);
        }
      }
      catch (StorageException $e) {
      }
339

340 341 342
      // 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'])) {
343
        foreach (_system_default_theme_features() as $feature) {
344
          if (!in_array($feature, $theme_object->info['features'])) {
345
            $cache[$theme]->set('features.' . $feature, NULL);
346 347 348 349
          }
        }
      }

350
      // Generate the path to the logo image.
351 352 353
      if ($cache[$theme]->get('features.logo')) {
        $logo_path = $cache[$theme]->get('logo.path');
        if ($cache[$theme]->get('logo.use_default')) {
354
          $cache[$theme]->set('logo.url', file_create_url($theme_object->getPath() . '/logo.svg'));
355
        }
356 357
        elseif ($logo_path) {
          $cache[$theme]->set('logo.url', file_create_url($logo_path));
358 359
        }
      }
360 361

      // Generate the path to the favicon.
362 363 364
      if ($cache[$theme]->get('features.favicon')) {
        $favicon_path = $cache[$theme]->get('favicon.path');
        if ($cache[$theme]->get('favicon.use_default')) {
365
          if (file_exists($favicon = $theme_object->getPath() . '/favicon.ico')) {
366
            $cache[$theme]->set('favicon.url', file_create_url($favicon));
367 368
          }
          else {
369
            $cache[$theme]->set('favicon.url', file_create_url('core/misc/favicon.ico'));
370 371
          }
        }
372 373
        elseif ($favicon_path) {
          $cache[$theme]->set('favicon.url', file_create_url($favicon_path));
374 375
        }
        else {
376
          $cache[$theme]->set('features.favicon', FALSE);
377
        }
378
      }
379
    }
380 381
  }

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  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_') {
416
      $config->set('features.' . Unicode::substr($key, 7), $value);
417 418 419 420 421 422
    }
    else if (!in_array($key, array('theme', 'logo_upload'))) {
      $config->set($key, $value);
    }
  }
  return $config;
423 424
}

425
/**
426 427 428
 * Prepares variables for time templates.
 *
 * Default template: time.html.twig.
429 430
 *
 * @param array $variables
431
 *   An associative array possibly containing:
432 433 434
 *   - attributes['timestamp']:
 *   - timestamp:
 *   - text:
435
 */
436
function template_preprocess_time(&$variables) {
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
  // 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']);
    }
    // Otherwise, use the literal datetime attribute.
    elseif (isset($variables['attributes']['datetime'])) {
      $variables['text'] = $variables['attributes']['datetime'];
    }
  }
}

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 494 495 496 497 498 499 500 501 502 503 504 505 506
/**
 * 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'];
  }

507
  $variables['required'] = FALSE;
508 509 510
  // For required datetime fields a 'form-required' class is appended to the
  // label attributes.
  if (!empty($element['#required'])) {
511
    $variables['required'] = TRUE;
512 513 514 515
  }
  $variables['content'] = $element['#children'];
}

516
/**
517
 * Prepares variables for links templates.
518
 *
519 520 521
 * Default template: links.html.twig.
 *
 * @param array $variables
522
 *   An associative array containing:
523
 *   - links: An associative array of links to be themed. The key for each link
524
 *     is used as its CSS class. Each link should be itself an array, with the
525 526
 *     following elements:
 *     - title: The link text.
527 528
 *     - url: (optional) The url object to link to. If omitted, no a tag is
 *       printed out.
529 530
 *     - attributes: (optional) Attributes for the anchor, or for the <span>
 *       tag used in its place if no 'href' is supplied. If element 'class' is
531
 *       included, it must be an array of one or more class names.
532 533
 *     If the 'href' element is supplied, the entire link array is passed to
 *     l() as its $options parameter.
534 535
 *   - attributes: A keyed array of attributes for the UL containing the
 *     list of links.
536
 *   - set_active_class: (optional) Whether each link should compare the
537
 *     route_name + route_parameters or href (path), language and query options
538 539 540 541
 *     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.
542 543 544 545 546
 *     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
547
 *     JavaScript is added in system_page_attachments().
548 549 550
 *   - 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:
551 552
 *     - text: The heading text.
 *     - level: The heading level (e.g. 'h2', 'h3').
553
 *     - attributes: (optional) An array of the CSS attributes for the heading.
554
 *     When using a string it will be used as the text of the heading and the
555 556
 *     level will default to 'h2'. Headings should be used on navigation menus
 *     and any list of links that consistently appears on multiple pages. To
557
 *     make the heading invisible use the 'visually-hidden' CSS class. Do not
558 559
 *     use 'display:none', which removes it from screen readers and assistive
 *     technology. Headings allow screen reader and keyboard only users to
560 561 562
 *     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.
563
 *
564 565
 * Unfortunately links templates duplicate the "active" class handling of l()
 * and LinkGenerator::generate() because it needs to be able to set the "active"
566 567 568 569 570
 * 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:
571
 *   jQuery('li:has("a.is-active")')
572
 *
573
 * @see \Drupal\Core\Utility\LinkGenerator
574
 * @see \Drupal\Core\Utility\LinkGenerator::generate()
575
 * @see system_page_attachments()
576
 */
577
function template_preprocess_links(&$variables) {
578
  $links = $variables['links'];
579
  $heading = &$variables['heading'];
580

581 582
  if (!empty($links)) {
    // Prepend the heading to the list, if any.
583
    if (!empty($heading)) {
584
      // Convert a string heading into an array, using a H2 tag by default.
585
      if (is_string($heading)) {
586
        $heading = array('text' => $heading);
587
      }
588 589 590 591 592
      // Merge in default array properties into $heading.
      $heading += array(
        'level' => 'h2',
        'attributes' => array(),
      );
593 594
      // Convert the attributes array into an Attribute object.
      $heading['attributes'] = new Attribute($heading['attributes']);
595
      $heading['text'] = SafeMarkup::checkPlain($heading['text']);
596 597
    }

598
    $variables['links'] = array();
599
    foreach ($links as $key => $link) {
600
      $item = array();
601
      $link += array(
602
        'ajax' => NULL,
603
        'url' => NULL,
604 605
      );

606
      $li_attributes = array();
607
      $keys = ['title', 'url'];
608 609
      $link_element = array(
        '#type' => 'link',
610
        '#title' => $link['title'],
611
        '#options' => array_diff_key($link, array_combine($keys, $keys)),
612
        '#url' => $link['url'],
613
        '#ajax' => $link['ajax'],
614 615
      );

616 617
      // Handle links and ensure that the active class is added on the LIs, but
      // only if the 'set_active_class' option is not empty.
618
      if (isset($link['url'])) {
619
        if (!empty($variables['set_active_class'])) {
620

621 622
          // Also enable set_active_class for the contained link.
          $link_element['#options']['set_active_class'] = TRUE;
623

624
          if (!empty($link['language'])) {
625
            $li_attributes['hreflang'] = $link['language']->getId();
626 627 628 629 630 631 632 633 634 635
          }

          // 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);
          }

636 637 638 639 640 641 642 643 644
          /** @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;
645
          }
646
        }
647

648
        $item['link'] = $link_element;
649
      }
650

651
      // Handle title-only text items.
652
      $item['text'] = $link['title'];
653 654
      if (isset($link['attributes'])) {
        $item['text_attributes'] = new Attribute($link['attributes']);
655
      }
656

657 658
      // Handle list item attributes.
      $item['attributes'] = new Attribute($li_attributes);
659

660
      // Add the item to the list of links.
661
      $variables['links'][$key] = $item;
662
    }
663
  }
664
}
Dries's avatar
Dries committed
665

666
/**
667
 * Prepares variables for image templates.
668
 *
669 670 671
 * Default template: image.html.twig.
 *
 * @param array $variables
672
 *   An associative array containing:
673
 *   - uri: Either the path of the image file (relative to base_path()) or a
674
 *     full URL.
675 676
 *   - width: The width of the image (if known).
 *   - height: The height of the image (if known).
677 678 679 680 681
 *   - 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
682
 *     accessibility requirements, so it is strongly encouraged for code
683
 *     calling _theme('image') to pass a meaningful value for this variable.
684 685 686
 *     - 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
687 688 689
 *   - 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.
690
 *   - srcset: Array of multiple URIs and sizes/multipliers.
691 692
 *   - 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
693
 */
694
function template_preprocess_image(&$variables) {
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
  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);
  }
715

716
  foreach (array('width', 'height', 'alt', 'title', 'sizes') as $key) {
717
    if (isset($variables[$key])) {
718 719 720 721 722
      // If the property has already been defined in the attributes,
      // do not override, including NULL.
      if (array_key_exists($key, $variables['attributes'])) {
        continue;
      }
723
      $variables['attributes'][$key] = $variables[$key];
724
    }
725
  }
726
}
Dries's avatar
Dries committed
727

Dries's avatar
Dries committed
728
/**
729
 * Prepares variables for table templates.
730
 *
731 732 733
 * Default template: table.html.twig.
 *
 * @param array $variables
734 735 736 737
 *   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:
738 739
 *     - data: The localized title of the table column.
 *     - field: The database field represented in the table column (required
740
 *       if user is to be able to sort on this column).
741 742 743 744 745 746 747 748 749 750 751
 *     - 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.
752 753 754 755
 *     - 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:
756
 *     - data: An array of cells.
757
 *     - Any HTML attributes, such as "class", to apply to the table row.
758
 *     - no_striping: A Boolean indicating that the row should receive no
759
 *       'even / odd' styling. Defaults to FALSE.
760 761
 *     Each cell can be either a string or an associative array with the
 *     following keys:
762 763
 *     - data: The string to display in the table cell.
 *     - header: Indicates this cell is a header.
764 765
 *     - Any HTML attributes, such as "colspan", to apply to the table cell.
 *     Here's an example for $rows:
766
 *     @code
767 768
 *     $rows = array(
 *       // Simple row
769
 *       array(
770
 *         'Cell 1', 'Cell 2', 'Cell 3'
771
 *       ),
772 773 774
 *       // 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')
775
 *       ),
776
 *     );
777
 *     @endcode
778 779
 *   - footer: An array of table rows which will be printed within a <tfoot>
 *     tag, in the same format as the rows element (see above).
780 781 782 783 784 785 786 787 788 789 790
 *   - 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:
791
 *     @code
792 793 794
 *     $colgroup = array(
 *       // COLGROUP with one COL element.
 *       array(
795
 *         array(
796
 *           'class' => array('funky'), // Attribute for the COL element.
797 798
 *         ),
 *       ),
799 800 801 802 803 804 805 806 807 808
 *       // 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.
 *       ),
 *     );
809
 *     @endcode
810 811 812 813
 *     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.
814 815
 *   - empty: The message to display in an extra row if table does not have any
 *     rows.
816
 */
817 818 819
function template_preprocess_table(&$variables) {
  $is_sticky = !empty($variables['sticky']);
  $is_responsive = !empty($variables['responsive']);
820

821
  // Format the table columns:
822 823
  if (!empty($variables['colgroups'])) {
    foreach ($variables['colgroups'] as &$colgroup) {
824 825
      // Check if we're dealing with a simple or complex column
      if (isset($colgroup['data'])) {
826 827 828
        $cols = $colgroup['data'];
        unset($colgroup['data']);
        $colgroup_attributes = $colgroup;
829 830 831
      }
      else {
        $cols = $colgroup;
832
        $colgroup_attributes = array();
833
      }
834 835 836 837 838 839 840 841
      $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);
842 843 844 845 846
        }
      }
    }
  }

847 848 849
  // Build an associative array of responsive classes keyed by column.
  $responsive_classes = array();

850
  // Format the table header:
851
  $ts = array();
852
  $header_columns = 0;
853 854 855
  if (!empty($variables['header'])) {
    $ts = tablesort_init($variables['header']);

856 857 858
    // Use a separate index with responsive classes as headers
    // may be associative.
    $responsive_index = -1;
859
    foreach ($variables['header'] as $col_key => $cell) {
860 861 862
      // Increase the responsive index.
      $responsive_index++;

863
      if (!is_array($cell)) {
864
        $header_columns++;
865
        $cell_content = $cell;
866
        $cell_attributes = new Attribute();
867 868 869
        $is_header = TRUE;
      }
      else {
870 871 872 873 874 875
        if (isset($cell['colspan'])) {
          $header_columns += $cell['colspan'];
        }
        else {
          $header_columns++;
        }
876 877 878 879
        $cell_content = '';
        if (isset($cell['data'])) {
          $cell_content = $cell['data'];
          unset($cell['data']);
880
        }
881 882 883 884 885 886 887 888 889 890
        // 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'])) {
891
            $responsive_classes[$responsive_index] = RESPONSIVE_PRIORITY_MEDIUM;
892 893
          }
          elseif (in_array(RESPONSIVE_PRIORITY_LOW, $cell['class'])) {
894
            $responsive_classes[$responsive_index] = RESPONSIVE_PRIORITY_LOW;
895
          }
896
        }
897 898 899 900 901

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

902
        tablesort_header($cell_content, $cell, $variables['header'], $ts);
903 904 905

        // tablesort_header() removes the 'sort' and 'field' keys.
        $cell_attributes = new Attribute($cell);
906
      }
907 908 909 910
      $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
911
    }
912
  }
913
  $variables['header_columns'] = $header_columns;
Dries's avatar
Dries committed
914

915 916 917 918 919
  // 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) {
920
        $cells = $row;
921
        $row_attributes = array();
922

923 924 925
        // Check if we're dealing with a simple or complex row
        if (isset($row['data'])) {
          $cells = $row['data'];
926
          $variables['no_striping'] = isset($row['no_striping']) ? $row['no_striping'] : FALSE;
927

928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
          // 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;
949
            }
950 951 952 953 954 955
            else {
              $cell_content = '';
              if (isset($cell['data'])) {
                $cell_content = $cell['data'];
                unset($cell['data']);
              }
956

957 958 959
              // Flag the cell as a header or not and remove the flag.
              $is_header = !empty($cell['header']);
              unset($cell['header']);
960

961 962 963 964 965
              $cell_attributes = $cell;

              if (is_array($cell_content)) {
                $cell_content = drupal_render($cell_content);
              }
966
            }
967
            // Active table sort information.
968
            if (isset($variables['header'][$col_key]['data']) && $variables['header'][$col_key]['data'] == $ts['name'] && !empty($variables['header'][$col_key]['field'])) {
969
              $variables[$section][$row_key]['cells'][$col_key]['active_table_sort'] = TRUE;
970 971 972 973 974 975 976 977 978
            }
            // 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;
979
          }
980
        }
Dries's avatar
Dries committed
981 982 983
      }
    }
  }
984 985 986
  if (empty($variables['no_striping'])) {
    $variables['attributes']['data-striping'] = 1;
  }
Dries's avatar
Dries committed
987 988
}

989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
/**
 * 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');
  }
}

1008
/**
1009 1010 1011
 * Prepares variables for item list templates.
 *
 * Default template: item-list.html.twig.
1012 1013
 *
 * @param array $variables
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
 *   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").
 *
1024
 * @see https://www.drupal.org/node/1842756
1025 1026 1027
 */
function template_preprocess_item_list(&$variables) {
  foreach ($variables['items'] as &$item) {
1028
    $attributes = array();
1029 1030
    // If the item value is an array, then it is a render array.
    if (is_array($item)) {
1031 1032 1033 1034
      // List items support attributes via the '#wrapper_attributes' property.
      if (isset($item['#wrapper_attributes'])) {
        $attributes = $item['#wrapper_attributes'];
      }
1035 1036 1037 1038
      // 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.
1039
      foreach (Element::children($item) as $key) {
1040 1041 1042 1043
        $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'])) {
1044 1045 1046
          // Since item-list.html.twig supports both strings and render arrays
          // as items, the items of the nested list may have been specified as
          // the child elements of the nested list, instead of #items. For
1047 1048
          // convenience, we automatically move them into #items.
          if (!isset($child['#items'])) {
1049 1050 1051
            // This is the same condition as in
            // \Drupal\Core\Render\Element::children(), which cannot be used
            // here, since it triggers an error on string values.
1052 1053 1054 1055 1056 1057 1058 1059 1060
            foreach ($child as $child_key => $child_value) {
              if ($child_key[0] !== '#') {
                $child['#items'][$child_key] = $child_value;
                unset($child[$child_key]);
              }
            }
          }
          // Lastly, inherit the original theme variables of the current list.
          $child['#theme'] = $variables['theme_hook_original'];
1061
          $child['#list_type'] = $variables['list_type'];