Class: Structures_DataGrid

Source Location: /Structures_DataGrid-0.5.1/DataGrid.php

Class Overview

Structures_DataGrid_Core
   |
   --Structures_DataGrid_Renderer
      |
      --Structures_DataGrid

Structures_DataGrid Class

Author(s):

Andrew S. Nagy <asnagy at webitecture.org>

Version:

$Revision: 1.4 $

Inherited Variables

Class: Structures_DataGrid_Renderer

Structures_DataGrid_Renderer::$renderer

Class: Structures_DataGrid_Core

Structures_DataGrid_Core::$columnSet
Structures_DataGrid_Core::$page
Structures_DataGrid_Core::$pageList
Structures_DataGrid_Core::$pager
Structures_DataGrid_Core::$recordSet
Structures_DataGrid_Core::$rowlimit
Structures_DataGrid_Core::$sortArray

Inherited Methods

Class: Structures_DataGrid_Renderer

Structures_DataGrid_Renderer::Structures_DataGrid_Renderer(): Constructor
Structures_DataGrid_Renderer::getRenderer(): Get Renderer
Structures_DataGrid_Renderer::render(): Render
Structures_DataGrid_Renderer::setRenderer(): Set Renderer

Class: Structures_DataGrid_Core

Structures_DataGrid_Core::Structures_DataGrid_Core(): Constructor
Structures_DataGrid_Core::addColumn(): Adds a DataGridColumn object to this DataGrid object
Structures_DataGrid_Core::addRecord(): Adds a DataGrid_Record object to this DataGrid object
Structures_DataGrid_Core::bind(): A simple way to add an associative array record set to the data grid.
Structures_DataGrid_Core::dropRecord(): Drops a DataGridRecord object from this DataGrid object
Structures_DataGrid_Core::getCurrentPage(): Retrieves the current page number when paging is implemented
Structures_DataGrid_Core::setCurrentPage(): Define the current page number. This is used when paging is implemented
Structures_DataGrid_Core::sortRecordSet(): Sorts the records by the defined field.

Class Details

[line 67]
Structures_DataGrid Class

A PHP class to implement the functionality provided by the .NET Framework's DataGrid control. This class can produce a data driven list in many formats based on a defined record set. Commonly, this is used for outputting an HTML table based on a record set from a database or an XML document. It allows for the output to be published in many ways, including an HTML table, an HTML Template, an Excel spreadsheet, an XML document. The data can be sorted and paged, each cell can have custom output, and the table can be custom designed with alternating color rows.

Quick Example: <?php require('Structures/DataGrid.php'); $dg = new Structures_DataGrid(); $result = mysql_query('SELECT * FROM users'); while ($rs = mysql_fetch_assoc($result)) { $dataSet[] = $rs; } $dg->bind($dataSet); echo $dg->render(); ?>

Author: Andrew S. Nagy <asnagy@webitecture.org>
Version: $Revision: 1.4 $
Access: public

[ Top ]

Method Detail

Structures_DataGrid (Constructor) [line 80]

void Structures_DataGrid(
[string
$limit = null], [string
$page = 1], [string
$renderer = DATAGRID_RENDER_TABLE])

Constructor

Acts somewhat as a factory and instantiates the Renderer and the Core

Access: public

Parameters:

string	`$limit`	—	The row limit per page.
string	`$page`	—	The current page viewed.
string	`$renderer`	—	The renderer to use.

[ Top ]

dump [line 94]

void dump(
)

Method used for debuging purposes only. Displays a dump of the DataGrid object.

Access: public

[ Top ]