com.lokorin.dfcrafters.lib
[ class tree: com.lokorin.dfcrafters.lib ] [ index: com.lokorin.dfcrafters.lib ] [ all elements ]

Class: TableDisplayer

Source Location: /_includes/lib_displayer.php

Class Overview

AbstractTableDisplayer
   |
   --TableDisplayer

Describes a table displayer which displays and splits up table contents over several pages. It allows pages to display menu bars so the users can select the desired page which displays a specified number of table rows.


Author(s):

  • Andreas Launila

Variables

Methods


Inherited Variables

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 213]
Describes a table displayer which displays and splits up table contents over several pages. It allows pages to display menu bars so the users can select the desired page which displays a specified number of table rows.



Tags:

author:  Andreas Launila


[ Top ]


Class Variables

$queryAppandage =

[line 226]

The appandage to the queries, the appandage specifies what should be displayed. The appandage is placed after 'FROM table'. I.e. to get the query "SELECT * FROM foo WHERE MATCH (title, body) AGAINST ('bar')" one should use "WHERE MATCH (title, body) AGAINST ('foo')".



Tags:

access:  private

Type:   string


[ Top ]

$table =

[line 218]

The name of the table that the displayer should display from.



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 237]

TableDisplayer __construct( string $tableName, [integer $rowsPerPage = 10], [string $queryAppandage = ''])

Constructor for TableDisplayer.



Tags:

access:  public


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

Parameters:

string   $tableName   The name of the table that the viewer should
integer   $rowsPerPage   The number of rows that should be displayed per page.
string   $queryAppandage   An option sql appandage that specifies a sub set of the rows that should be displayed. The default is that all rows are displayed.

[ Top ]

method getPageRows [line 270]

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 286]

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 getSqlSelector [line 248]

string getSqlSelector( )

Gets the sql selector that represents what the displayer will display on the current page.



Tags:

return:  An sql statement describing a subset of rows.
access:  public


[ Top ]


Documentation generated on Tue, 10 Jan 2006 17:06:27 +0100 by phpDocumentor 1.3.0RC4