Class: Structures_DataGrid_Renderer

Source Location: /Structures_DataGrid-0.5.1/DataGrid/Renderer.php

Class Overview

Structures_DataGrid_Core
   |
   --Structures_DataGrid_Renderer

Structures_DataGrid_Renderer Class

Author(s):

Andrew S. Nagy <asnagy at webitecture.org>

Version:

$Revision: 1.5 $

Variables

$renderer

Methods

Child classes:

Structures_DataGrid: Structures_DataGrid Class

Inherited Variables

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_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 35]
Structures_DataGrid_Renderer Class

This class handles mangeing the output for the DataGrid. By default, the output is handled by the HTML Table renderer.

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

[ Top ]

Class Variables

$renderer =

[line 37]

Type:

mixed

[ Top ]

Method Detail

Structures_DataGrid_Renderer (Constructor) [line 48]

Structures_DataGrid_Renderer Structures_DataGrid_Renderer(
[string
$renderer = DATAGRID_RENDER_TABLE])

Constructor

Determins the appropriate renderer to use. Uses the HTML_Table renderer as the default.

Access: public

Parameters:

string $renderer — The renderer to use.

[ Top ]

getRenderer [line 80]

void &getRenderer(
)

Get Renderer

Retrieves the renderer object as a reference

Access: public

[ Top ]

render [line 64]

void render(
string
$limit, string
$page)

Render

This calls the spcified renderer's render method.

Access: public

Parameters:

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

[ Top ]

setRenderer [line 93]

void setRenderer(
string
$renderer)

Set Renderer

Defines which renderer to be used by the DataGrid

Access: public

Parameters:

string $renderer — The defined renderer string

[ Top ]