function theme_tableselect in Elements 6

Same name and namespace in other branches

1. 5 elements.module \theme_tableselect()

Returns HTML for a table with radio buttons or checkboxes.

An example of per-row options:

$options = array();
$options[0]['title'] = "A red row"
$options[0]['#attributes'] = array ('class' => array('red-row'));
$options[1]['title'] = "A blue row"
$options[1]['#attributes'] = array ('class' => array('blue-row'));

$form['myselector'] = array (
'#type' => 'tableselect',
'#title' => 'My Selector'
'#options' => $options,
);

Parameters

$element: An associative array containing the properties and children of the tableselect element. Properties used: #header, #options, #empty, and #js_select. The #options property is an array of selection options; each array element of #options is an array of properties. These properties can include #attributes, which is added to the table row's HTML attributes; see theme_table().

File

./elements.theme.inc, line 38

The theme include file for the elements module.

Code

function theme_tableselect($element) {
  $rows = array();
  $header = $element['#header'];
  if (!empty($element['#options'])) {

    // Generate a table row for each selectable item in #options.
    foreach (element_children($element) as $key) {
      $row = array();
      $row['data'] = array();
      if (isset($element['#options'][$key]['#attributes'])) {
        $row += $element['#options'][$key]['#attributes'];
      }

      // Render the checkbox / radio element.
      $element[$key]['#printed'] = NULL;

      // Drupal 6 only
      $row['data'][] = drupal_render($element[$key]);

      // As theme_table only maps header and row columns by order, create the
      // correct order by iterating over the header fields.
      foreach ($element['#header'] as $fieldname => $title) {
        $row['data'][] = $element['#options'][$key][$fieldname];
      }
      $rows[] = $row;
    }

    // Add an empty header or a "Select all" checkbox to provide room for the
    // checkboxes/radios in the first table column.
    if ($element['#js_select']) {

      // Add a "Select all" checkbox.

      //drupal_add_js('misc/tableselect.js');

      //array_unshift($header, array('class' => 'select-all'));
      array_unshift($header, theme('table_select_header_cell'));

      // Drupal 6 only
    }
    else {

      // Add an empty header when radio buttons are displayed or a "Select all"
      // checkbox is not desired.
      array_unshift($header, '');
    }
  }

  // Add the 'empty' row message if available.
  if (!count($rows) && $element['#empty']) {
    $header_count = 0;
    foreach ($header as $header_cell) {
      if (is_array($header_cell)) {
        $header_count += isset($header_cell['colspan']) ? $header_cell['colspan'] : 1;
      }
      else {
        $header_count++;
      }
    }
    $rows[] = array(
      array(
        'data' => $element['#empty'],
        'colspan' => $header_count,
        'class' => 'empty message',
      ),
    );
  }
  return theme('table', $header, $rows, $element['#attributes']);
}