Docs For Class EmbeddedArrayResultPrinter

Description

Print out an Array of items in rows and columns in a TABLE HTML element.

version: $Id: EmbeddedArrayResultPrinter.class.php,v 1.12 2007/09/19 14:04:49 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /polyphony/main/library/ResultPrinter/EmbeddedArrayResultPrinter.class.php (line 24)

ResultPrinter
   |
   --EmbeddedArrayResultPrinter

Direct descendents

Class	Description
AgentBrowserResultPrinter	A result printer for the WAgentBrowser.

Variable Summary

mixed $_array

mixed $_callbackFunction

mixed $_currentItem

mixed $_numColumns

mixed $_overridePage

mixed $_pageSize

mixed $_tableStyle

mixed $_tdStyle

mixed $_trStyle

Method Summary

EmbeddedArrayResultPrinter EmbeddedArrayResultPrinter (mixed $array, integer $numColumns, integer $numResultsPerPage, string $callbackFunction, object $iterator, optional 4)

string createFooterRow ()

string createHeaderRow ()

void createItemElement (string $content)

string createTDElement (string $content, optional $colspan, [optional $align = 'left'])

string createTRElement ()

string getMarkup ([optional $shouldPrintFunction = NULL])

void overridePageNumber (mixed $number, integer $number )

void setTableStyle (mixed $style)

void setTDStyle (mixed $style)

void setTRStyle (mixed $style)

Variables

mixed $_array (line 28)

mixed $_callbackFunction (line 32)

mixed $_currentItem (line 38)

mixed $_numColumns (line 29)

mixed $_overridePage = -1 (line 31)

mixed $_pageSize (line 30)

mixed $_tableStyle = '' (line 34)

mixed $_tdStyle = 'padding: 3px;' (line 35)

mixed $_trStyle = '' (line 36)

Methods

Constructor EmbeddedArrayResultPrinter (line 53)

Constructor

access: public

EmbeddedArrayResultPrinter EmbeddedArrayResultPrinter (mixed $array, integer $numColumns, integer $numResultsPerPage, string $callbackFunction, object $iterator, optional 4)

object $iterator: The iterator to print.
integer $numColumns: The number of result columns to print on each page.
integer $numResultsPerPage: The number of iterator items to print on a page.
string $callbackFunction: The name of the function that will be called to to print each result.
optional 4: mixed $callbackArgs Any additional arguements will be stored and passed on to the callback function.

createFooterRow (line 129)

Builds the footer row of this result table.

string createFooterRow ()

Redefined in descendants as:

AgentBrowserResultPrinter::createFooterRow()

createHeaderRow (line 119)

Builds the header row of this result table.

string createHeaderRow ()

Redefined in descendants as:

AgentBrowserResultPrinter::createHeaderRow()

createItemElement (line 109)

Creates the HTML table element(s) for the passed content.

access: protected

void createItemElement (string $content)

string $content

Redefined in descendants as:

AgentBrowserResultPrinter::createItemElement()

createTDElement (line 142)

Creates a table TD element with the passed content.

string createTDElement (string $content, optional $colspan, [optional $align = 'left'])

string $content
optional $colspan: integer $colspan The number of columns for this element to span.
optional $align: string $align The text alignment.

createTRElement (line 155)

Returns the starting tag of a TR element.

string createTRElement ()

Redefined in descendants as:

AgentBrowserResultPrinter::createTRElement()

getMarkup (line 182)

Returns a block of HTML markup.

access: public

string getMarkup ([optional $shouldPrintFunction = NULL])

optional $shouldPrintFunction: string $shouldPrintFunction The name of a function that will return a boolean specifying whether or not to filter a given result. If null, all results are printed.

overridePageNumber (line 167)

Called if it is desired to override the page number that is displayed.

void overridePageNumber (mixed $number, integer $number )

integer $number

setTableStyle (line 97)

Sets the style of the TABLE element.

void setTableStyle (mixed $style)

setTDStyle (line 77)

Sets the style of the TD elements of this table.

void setTDStyle (mixed $style)

setTRStyle (line 87)

Sets the style of the TR elements of this table.

void setTRStyle (mixed $style)

Inherited Methods

Inherited From ResultPrinter

ResultPrinter::getPageLinks()
ResultPrinter::getStartingNumber()
ResultPrinter::setNamespace()
ResultPrinter::setStartingNumber()
ResultPrinter::startingNumberParam()