Structures_DataGrid_Renderer_Flexy

Availability

This driver is experimental and has not been officially released yet. It is only available from CVS.

Supported operations modes

This driver supports the following operation modes:

Options

This driver accepts the following options:

General notes

This driver does not support the render() method, it only is able to be attached setting the container to a current Flexy instance. Options to the renderer must also be passed using the setOptions() method.

Flexy output is buffered using the DataGrid getOutput() method.

This driver assigns the following Flexy template variables: - columnSet: array of columns' labels and sorting links - columnHeader: object of columns' labels and sorting links - recordSet: associate array of records values - numberedSet: numbered array of records values - currentPage: current page (starting from 1) - recordLimit: number of rows per page - pagesNum: number of pages - columnsNum: number of columns - recordsNum: number of records in the current page - totalRecordsNum: total number of records - firstRecord: first record number (starting from 1) - lastRecord: last record number (starting from 1)

This driver also register a Smarty custom function named getPaging that can be called from Smarty templates with {getPaging} in order to print paging links. This function accepts any of the Pager::factory() options as parameters.

Dynamic Template example, featuring sorting and paging:

<!-- Show paging links using the custom getPaging function --> {getPaging():h} <p>Showing records {firstRecord} to {lastRecord} from {totalRecordsNum}, page {currentPage} of {pagesNum}</p> <table cellspacing="0"> <!-- Build header --> <tr> <th> {foreach:columnSet,column} <td><a href="{column[link]:h}">{column[label]:h}</a></td> {end:} </th> </tr> <!-- Build body --> <tr class="{getRowCSS()}" flexy:foreach="numberedSet,k,row"> {foreach:row,field} <td>{field}</td> {end:} </tr> </table>

Static Template example, featuring sorting and paging:

<table cellspacing="0"> <!-- Build header --> <tr> <th> <td> <a href="{columnHeader.name[link]:h}">{columnHeader.field1[label]:h}</a> </td> <td> <a href="{columnHeader.surname[link]:h}">{columnHeader.field2[label]:h}</a> </td> </th> </tr> <!-- Build body --> <tr class="{getRowCSS()}" flexy:foreach="recordSet,k,row"> <td>{row[field1]}</td> <td>{row[field2]}</td> </tr> </table>

require_once 'HTML/Template/Flexy.php'; require_once 'Structures/DataGrid.php'; require_once 'Structures/DataGrid/Renderer/Flexy.php'; $tpl = new HTML_Template_Flexy($config['HTML_Template_Flexy']); $dg =& new Structures_DataGrid($_GET['setPerPage'] ? $_GET['setPerPage'] : 10,$_GET['page'] ? $_GET['page'] : 1); $dg->bind($dataObject); $renderer = new Structures_DataGrid_Renderer_Flexy(); $renderer->setContainer($tpl); $renderer->setOptions($config['Structures_DataGrid']); $dg->attachRenderer($renderer); $this->tpl->compile($template); echo $dg->getOutput();