function tablesort_header in Drupal 5

Same name and namespace in other branches

1. 8 core/includes/tablesort.inc \tablesort_header()
2. 4 includes/tablesort.inc \tablesort_header()
3. 6 includes/tablesort.inc \tablesort_header()
4. 7 includes/tablesort.inc \tablesort_header()

Format a column header.

If the cell in question is the column header for the current sort criterion, it gets special formatting. All possible sort criteria become links.

Parameters

$cell: The cell to format.

$header: An array of column headers in the format described in theme_table().

$ts: The current table sort context as returned from tablesort_init().

Return value

A properly formatted cell, ready for _theme_table_cell().

1 call to tablesort_header()

theme_table in includes/theme.inc

Return a themed table.

File

includes/tablesort.inc, line 62

Functions to aid in the creation of sortable tables.

Code

function tablesort_header($cell, $header, $ts) {

  // Special formatting for the currently sorted column header.
  if (is_array($cell) && isset($cell['field'])) {
    $title = t('sort by @s', array(
      '@s' => $cell['data'],
    ));
    if ($cell['data'] == $ts['name']) {
      $ts['sort'] = $ts['sort'] == 'asc' ? 'desc' : 'asc';
      if (isset($cell['class'])) {
        $cell['class'] .= ' active';
      }
      else {
        $cell['class'] = 'active';
      }
      $image = theme('tablesort_indicator', $ts['sort']);
    }
    else {

      // If the user clicks a different header, we want to sort ascending initially.
      $ts['sort'] = 'asc';
      $image = '';
    }
    if (!empty($ts['query_string'])) {
      $ts['query_string'] = '&' . $ts['query_string'];
    }
    $cell['data'] = l($cell['data'] . $image, $_GET['q'], array(
      'title' => $title,
    ), 'sort=' . $ts['sort'] . '&order=' . urlencode($cell['data']) . $ts['query_string'], NULL, FALSE, TRUE);
    unset($cell['field'], $cell['sort']);
  }
  return $cell;
}