Class: CustomTableDisplayer

Source Location: /_includes/lib_displayer.php

Class Overview

AbstractTableDisplayer
   |
   --CustomTableDisplayer

A displayer that takes a custom query and executes it. It can be used to perform more advanced queries than the notmal displayer can.

Author(s):

Andreas Launila

Variables

Methods

Inherited Variables

Class: AbstractTableDisplayer

AbstractTableDisplayer::$currentPage
AbstractTableDisplayer::$rowsPerPage

Inherited Methods

Class: AbstractTableDisplayer

AbstractTableDisplayer::__construct(): Constructor for AbstractTableDisplayer.
AbstractTableDisplayer::getPageMenuBar(): Gets a page menu associated with the table displayer. The menu contains links ordered in a bar which can be used to change the current page.
AbstractTableDisplayer::getPageRows(): Gets the rows that should be displayed on the current page.
AbstractTableDisplayer::getRowCount(): Gets the number of rows that the viewer can display in total. This is an abstract implementation and should be overridden by all subclasses.
AbstractTableDisplayer::setRowsPerPage(): Sets the number of rows that should be displayed on each page by the displayer.

Class Details

[line 162]
A displayer that takes a custom query and executes it. It can be used to perform more advanced queries than the notmal displayer can.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$countQuery =

[line 168]

The SQL query that should be used for counting all the rows that should be displayed.

Tags:

access:

private

Type:

string

[ Top ]

$selectQuery =

[line 174]

The SQL query that should be used for selecting all the rows that should be displayed.

Tags:

access:

private

Type:

string

[ Top ]

Class Methods

constructor __construct [line 186]

CustomTableDisplayer __construct(
string
$countQuery, string
$selectQuery, [integer
$rowsPerPage = 10])

Constructor for CustomTableDisplayer.

Tags:

access:

public

Overrides AbstractTableDisplayer::__construct() (Constructor for AbstractTableDisplayer.)

Parameters:

string	$countQuery	The query that should be used for counting the rows that should be displayed from the database.
string	$selectQuery	The query that should be used for selecting the rows that should be displayed from the database. It should not contain the LIMIT keyword.
integer	$rowsPerPage	The number of rows that should be displayed per page.

[ Top ]

method getPageRows [line 195]

void getPageRows(
[mixed
$fields = array()])

Tags:

access:	public
see:	AbstractTableDisplayer.getPageRows()

Overrides AbstractTableDisplayer::getPageRows() (Gets the rows that should be displayed on the current page.)

[ Top ]

method getRowCount [line 239]

void getRowCount(
)

Tags:

access:	protected
see:	AbstractTableDisplayer.getRowCount()

Overrides AbstractTableDisplayer::getRowCount() (Gets the number of rows that the viewer can display in total. This is an abstract implementation and should be overridden by all subclasses.)

[ Top ]

method getSqlQuery [line 212]

string getSqlQuery(
)

Gets the sql query that describes what should be retrieved for the current page.

Tags:

return:	A complete SQL query.
access:	public

[ Top ]

method getSqlSelector [line 232]

string getSqlSelector(
)

Gets an sql selector that describes the subset of rows that should be selected for the current page.

Tags:

return:	An sql selector.
access:	public

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:18 +0200 by phpDocumentor 1.3.0RC4