Class CompetitorListFormatter

Description

Formats QueryResults for use in outside documentation.

This class handles formatting list of competitors into the various layouts needed for people assembling a printed program offering choices such as tabbed delimited or pre-formatted text and can group the lists by affiliations or not.

Located in /include/classes/printed-formatting/CompetitorListFormatter.inc (line 21)

ListFormatter
   |
   --CompetitorListFormatter
Method Summary
 CompetitorListFormatter CompetitorListFormatter ()
 string _printText (array $arr, array $context)
Variables
Methods
Constructor CompetitorListFormatter (line 26)

Wraps the parent constructor with configuration choices

CompetitorListFormatter CompetitorListFormatter ()
_printText (line 45)

Implement the Textual formatter

Generates the pre formatted text list, collapse identical leaders

  • return: the next row fo the list
string _printText (array $arr, array $context)
  • array $arr: the current row from the DB
  • array $context: Tracks the last leader seen for collapsing checks

Redefinition of:
ListFormatter::_printText()
Abstract function, must be overrided for text output

Inherited Methods

Inherited From ListFormatter

 ListFormatter::ListFormatter()
 ListFormatter::formatAsTabbed()
 ListFormatter::formatAsText()
 ListFormatter::_format()
 ListFormatter::_printTabbed()
 ListFormatter::_printText()
 ListFormatter::_usesRowLookback()
 ListFormatter::_usesSectionLookback()

Documentation generated on Tue, 25 Apr 2006 13:00:26 -0400 by phpDocumentor 1.3.0RC3