function drupal_group_js

Default callback to group JavaScript items.

This function arranges the JavaScript items that are in the #items property of the scripts element into groups. When aggregation is enabled, files within a group are aggregated into a single file, significantly improving page loading performance by minimizing network traffic overhead.

This function puts multiple items into the same group if they are groupable and if they are for the same browsers. Items of the 'file' type are groupable if their 'preprocess' flag is TRUE. Items of the 'inline', 'settings', or 'external' type are not groupable.

This function also ensures that the process of grouping items does not change their relative order. This requirement may result in multiple groups for the same type and browsers, if needed to accommodate other items in between.

Parameters

$javascript: An array of JavaScript items, as returned by drupal_add_js(), but after alteration performed by drupal_get_js().

Return value

An array of JavaScript groups. Each group contains the same keys (e.g., 'data', etc.) as a JavaScript item from the $javascript parameter, with the value of each key applying to the group as a whole. Each group also contains an 'items' key, which is the subset of items from $javascript that are in the group.

See also

drupal_pre_render_scripts()

File

drupal/core/includes/common.inc, line 4021

Common functions that many Drupal modules will need to reference.

Code

function drupal_group_js($javascript) {
  $groups = array();

  // If a group can contain multiple items, we track the information that must
  // be the same for each item in the group, so that when we iterate the next
  // item, we can determine if it can be put into the current group, or if a
  // new group needs to be made for it.
  $current_group_keys = NULL;
  $index = -1;
  foreach ($javascript as $item) {

    // The browsers for which the JavaScript item needs to be loaded is part of
    // the information that determines when a new group is needed, but the order
    // of keys in the array doesn't matter, and we don't want a new group if all
    // that's different is that order.
    ksort($item['browsers']);
    switch ($item['type']) {
      case 'file':

        // Group file items if their 'preprocess' flag is TRUE.
        // Help ensure maximum reuse of aggregate files by only grouping
        // together items that share the same 'group' value and 'every_page'
        // flag. See drupal_add_js() for details about that.
        $group_keys = $item['preprocess'] ? array(
          $item['type'],
          $item['group'],
          $item['every_page'],
          $item['browsers'],
        ) : FALSE;
        break;
      case 'external':
      case 'setting':
      case 'inline':

        // Do not group external, settings, and inline items.
        $group_keys = FALSE;
        break;
    }

    // If the group keys don't match the most recent group we're working with,
    // then a new group must be made.
    if ($group_keys !== $current_group_keys) {
      $index++;

      // Initialize the new group with the same properties as the first item
      // being placed into it. The item's 'data' and 'weight' properties are
      // unique to the item and should not be carried over to the group.
      $groups[$index] = $item;
      unset($groups[$index]['data'], $groups[$index]['weight']);
      $groups[$index]['items'] = array();
      $current_group_keys = $group_keys ? $group_keys : NULL;
    }

    // Add the item to the current group.
    $groups[$index]['items'][] = $item;
  }
  return $groups;
}