theme_tableselect

Versions

7

theme_tableselect($variables)

Format a table with radio buttons or checkboxes.

Example:

@code $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

$variables An associative array containing:

• element: An associative array containing the properties and children of the tableselect element. Each option in $variables['element']['#options'] can contain an array keyed by '#attributes' which is added to the row's HTML attributes. @see theme_table Properties used: header, options, empty, js_select.

Return value

A themed HTML string representing the table.

Related topics

Default theme implementations

Functions and templates that present output to the user, and can be implemented by themes.

Form generation

Functions to enable the processing and display of HTML forms.

Code

includes/form.inc, line 2366

<?php
function theme_tableselect($variables) {
  $element = $variables['element'];
  $rows = array();
  $header = $element['#header'];
  if (!empty($element['#options'])) {
    // Generate a table row for each selectable item in #options.
    foreach ($element['#options'] as $key => $value) {
      $row = array();

      $row['data'] = array();
      if (isset($value['#attributes'])) {
        $row += $value['#attributes'];
      }
      // Render the checkbox / radio element.
      $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.
    $first_col = $element['#js_select'] ? array(theme('table_select_header_cell')) : array('');
    $header = array_merge($first_col, $header);
  }
  return theme('table', array('header' => $header, 'rows' => $rows, 'empty' => $element['#empty'], 'attributes' => $element['#attributes']));
}
?>

Login or register to post comments