function theme_table

The final call to the theme function needs to pass in an associative array as well which appears to have been changed for D7.

$output = theme('table', array('header' => $header, 'rows' => $rows));

Please add support for multiple rows in the table header or document how to achieve this with the existing function.

This seems to be undocumented as of yet, but the internal api function _theme_table_cell has a special condition when the cell (each element in a row array) is defined using the 'data' variant. When using this definition, if you specify an array instead of a string, it will drupal_render the contents.

For instance :

foreach ($objects as $key => $object) {
    // this is the well documented format
    $options[$key]['title'] = filter_xss($object->title);

    // this is the not well known format
    $options[$key]['awesomeness'] =  array(
      'data' => array(
        '#type' => 'select',
        '#options' => array(
          '0' => t('boring'),
          '1' => t('Awesome!'),
          '11' => t('TURNED UP TO ELEVEN!!11!')
        ),
        '#default_value' => $object->awesomeness,
     ));
}

$form['things'] = array(
    '#type' => 'tableselect',
    '#header' => array('title' => t('Title'), 'awesomeness' => t('AWESOMENESS')),
    '#options' => $options,
    '#empty' => t('No items available'), 
  );

This means you no longer have to have your own '#theme' function on the form to render the elements in the right cells.
This in turn means that you could end up deleting hundreds of lines of complex code that confuses themers and coders alike.

This code does work. it gives a fetal error.

theme('table', array(
    'header' => $header, 
    'rows' => $rows, 
    'attributes' => array('class' => 'mytable')
));

Fatal error: [] operator not supported for strings in C:\wamp\www\damjd\includes\theme.inc on line 1633

But the code below works.

theme('table', array(
    'header' => $header, 
    'rows' => $rows,
    'attributes' => array('width' => '100%')
));

Sometimes sticky headers will crash IE8. I haven't been able to reproduce this, but just in case anyone else is trying to figure out IE8 crashes on validated HTML and using theme_table properly, it's probably sticky headers.

I am trying to make Drupal assign column names as "id" to table headers and "headers" to table datas.
I want to add this option to templates.php
I think "theme_table" and "_theme_table_cell" functions" can do it, but I don't know how, and the second is not overridable.

I wrote this foreach loop

	foreach($header as $headings){
	if (is_array($headings)){
	$headers=$headings['data'] . " ";
	echo $headers;
		}
	else
	{
	$headers=$headings . " ";
	echo $headers;
		}
	}; 

which shows all of the column titles
As I clear the cache a message alerts that "data" is an undefined index in overridden function "theme_table".

Further I don't know how to assign the results to single cells.

So as you say, my form elements within a table cell don't have ajax attached to them. Could you point me in the right direction, where to start attaching it manually?

Thanks muchly

Not finding anything on this, and thinking I'm missing a #type. How do I make this work:

 $output['legend'] =  array(
            '#theme' => 'table', 
            '#prefix' => '<div style="width: 250px"><h3>Legend</h3>',
            '#suffix' => '</div>',
            'content' => array('header' => array(), 'rows' => $legend)
          );

I get warnings/errors if I don't specifically pass attributes, caption, colgroups, sticky, empty. This is very annoying.

One thing I'd like to note in regards to the class attribute and sticky...

If you are setting an attribute 'class', you must do it like this:

'attributes' => array('class' => array('table_dfs')),

...so 'class' is an array of class names (not a string).

I was not doing this, and when I set sticky => TRUE, my page was bombing out because it was trying to add another element to the class array which was a string.

FYI, default sort order does not work in D7, and the header-related documentation on this page appears to be incorrect in any case.

re: default sort order, see this bug: http://drupal.org/node/109493

For sorting, the header items need these keys: data, type & specifier.

For an entity's native properties, that's where it ends. But for fields you've added to the entity, the specifier should be an array with 'field' and 'column' keys. Here is an example:

$header_array = array(
      'name' => array('data' => 'Username', 'type' => 'property', 'specifier' => 'name', 'sort' => 'desc'),
      'location' => array('data' => 'Location', 'type' => 'field', 'specifier' => array('field' => 'field_city', 'column' => 'value'), 'sort' => 'desc'),
      'created' => array('data' => 'Date Joined', 'type' => 'property', 'specifier' => 'created', 'sort' => 'desc'),
      'motto' => array('data' => 'Motto'),
      'action' => array('data' => 'Last Action', 'type' => 'property', 'specifier' => 'access', 'sort' => 'desc'),
);

Note that the sort value has no effect because of the above-mentioned bug.

Then again, it may be that these docs were written to encourage coding in a way that's consistent with how the sort feature will work when it's fixed?

Posted by greggles on September 21, 2009 at 5:30pm

From berdir:

TableSort now works as an Extender, so you need to convert your query
to a dynamic db_select() query.

You then need to extend it with "->extend('TableSort')" and add the
table header by calling "->orderByHeader($header)".

Some Links:

An example from core: http://api.drupal.org/api/function/poll_votes/7
Extender doc page: http://drupal.org/node/508796

The example above can be extended as:

$rows = array(
      // Simple row
      array(
        array('data' => 'Cell 1', class=>'col_class_name'), 'Cell 2', 'Cell 3'
      ),
      // 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')
      )
    );

Adding td classes with:

array('data' => 'Cell 1', class=>'col_class_name')

This snippet helps to visualize the whole nesting scheme in a super simple manner. Additionally, it really works very fine in everyday life (hint: in a looping control structure you just have to substitute the first line with '$arr_rows[] =' ).

PHP

//Main arrays container array:
$arr_rows = array(
  //Contains the rows, is a numerical array (as default): 0, 1, 2 ... :
  array(  
    //'data' contains cell data as numerical arrays: 0, 1, 2 ... : 
    'data' => array(
      //Cell_1:  
      array('data' => 'R#1_Cell#1', 'class' => 'css-class-of-cell1'), 
      //Cell_2:
      array('data' => 'R#1_Cell#2', 'class' => 'css-class-of-cell2'), 
      //Cell_3:
      array('data' => 'R#1_Cell#3', 'class' => 'css-class-of-cell3'),
    ), 
    //Row attributes, e.g. 'class'
    'class' => array('css-class-of-row-1'),
  ),
  //Contains the rows, is a numerical array (as default): 0, 1, 2 ... :
  array(  
    //'data' contains cell data as numerical arrays: 0, 1, 2 ... : 
    'data' => array(
      //Cell_1:  
      array('data' => 'R#2_Cell#1', 'class' => 'css-class-of-cell1'), 
      //Cell_2:
      array('data' => 'R#2_Cell#2', 'class' => 'css-class-of-cell2'), 
      //Cell_3:
      array('data' => 'R#2_Cell#3', 'class' => 'css-class-of-cell3'),
    ), 
    //Row attributes, e.g. 'class'
    'class' => array('css-class-of-row-2'),
  ), 
);

print_R output

... (Array, 2 elements)

    0 (Array, 2 elements)
        data (Array, 3 elements)
            0 (Array, 2 elements)
                data (String, 10 characters ) R#1_Cell#1
                class (String, 18 characters ) css-class-of-cell1
            1 (Array, 2 elements)
                data (String, 10 characters ) R#1_Cell#2
                class (String, 18 characters ) css-class-of-cell2
            2 (Array, 2 elements)
                data (String, 10 characters ) R#1_Cell#3
                class (String, 18 characters ) css-class-of-cell3
        class (Array, 1 element)
            0 (String, 18 characters ) css-class-of-row-1
    1 (Array, 2 elements)
        data (Array, 3 elements)
            0 (Array, 2 elements)
                data (String, 10 characters ) R#2_Cell#1
                class (String, 18 characters ) css-class-of-cell1
            1 (Array, 2 elements)
                data (String, 10 characters ) R#2_Cell#2
                class (String, 18 characters ) css-class-of-cell2
            2 (Array, 2 elements)
                data (String, 10 characters ) R#2_Cell#3
                class (String, 18 characters ) css-class-of-cell3
        class (Array, 1 element)
            0 (String, 18 characters ) css-class-of-row-2

$output = theme('table', array(
'header' => $header,
'rows' => $rows,
'sticky' => TRUE, // or FALSE
)
);

I have used exactly same code..
$output = theme('table', array(
'header' => $header,
'rows' => $row,
'attributes' => array('width' => '100%')
));
dpm($output);
}
drupal_render($output);
}

dpm($output) give me bunchof table tags(HTML), but I can not able to reder those elements in the page..what do i do to render the elements

The no striping option has an issue and is being worked on here: http://drupal.org/node/935066

If you want the user to be able to sort on a column that has numbers, but the field was created as a string (text), you can get proper numerical sorting by converting the value in the query using the SQL functions CAST() or CONVERT() in a query addExpression function as in:

$query->addExpression('CAST(table.field_string_value as DECIMAL(3,1))', 'string_now_a_number');

this is like the most common way for me to use theme_table, i though it might save somebody else's time


$headers = array(
'user' => array('data' => t('Username'), 'field' => 'u.name'),
'status' => array('data' => t('Status'), 'field' => 'u.status'),
'ops' => array('date' => t('Operations'))

);

$query = db_select('users', 'u')
->extend('TableSort');

$result = $query->fields('u', array('uid', 'name', 'status'))
->orderByHeader($headers)
->execute();

$rows = array();
foreach ($result as $invited_users) {
$rows[$invited_users->uid] = array(
'username' => l($invited_users->name, 'user/' . $invited_users->uid),
'status' => $invited_users->status,
'ops' => l('delete', 'delete')
);
}

$form['invited_users'] = array(
'#markup' => theme('table', array(
'header' => $headers,
'rows' => $rows,
'attributes' => array('class' => array('invited_users')),
'#empty' =>t('No invited users yet'),
))
);

Thank you for posting this -- I intend to go through it so I understand how it's working. Looks like a very compact way to accomplish a lot. I've worked with Drupal for years but haven't used forms much, like the idea of giving the theme_table right to the form itself. There is always something new to learn here.

If you have setup your data and headers to work with Table api, such as below:

<?php
$headers = array(
      array('data' => 'First_Name', 'field' => 'First_Name'),
      array('data' => 'Last_Name', 'field' => 'Last_Name'),
  );

  $rows = array(
          array('field' => 'First_Name', 'data' => $result->first_name),
          array('field' => 'Last_Name', 'data' => $result->last_name),
  );

    $table_data = array(
      'header'     => $headers,
      'rows'       => $rows,
      'sticky'     => TRUE,
      'empty'      => 'No results found',
      'attributes' => array(),
      'caption'    => count($data['rows']) . ' rows',
      'colgroups'  => array()
    );

    $output = theme_table($table_data);

?>

This snippet will let you then export it to csv. You'll need to put this in it's own function.

<?php

  $filename = time() . '-export.csv';
  drupal_add_http_header('Content-Type', 'text/csv; utf-8');
  drupal_add_http_header(
    'Content-Disposition',
    'attachment; filename=' . $filename
  );


  $fp = fopen('php://output', 'w');
  $keys = array();
  foreach ($headers as $key => $value) {
    $keys[] = $value['field'];
  }
  if ($keys) {
    fputcsv($fp, $keys);
  }
  foreach ($rows as $key => $value) {
    $line = array();
    foreach ($value as $cellkey => $cell) {
      $line[] = $cell['data'];
    }
    fputcsv($fp, $line);
  }
  fclose($fp);
  drupal_exit();
?>

The loop that builds the rows simply increments $i without considering colspan settings in the header. This causes a misalignment of the header to the data columns when applying the vertical striping. Basically the "active" class shows up one column early on every column after a header column of colspan 2.