SRFOutline Class Reference

Inherits SMWResultPrinter.

List of all members.

Public Member Functions

 getName ()
 Get a human readable label for this printer.
 printItem ($item)
 Code mostly copied from SMW's SMWListResultPrinter::getResultText().
 printTree ($outline_tree, $level=0)
 getParameters ()
 A function to describe the allowed parameters of a query using any specific format - most query printers should override this function.

Protected Member Functions

 handleParameters (array $params, $outputmode)
 Read an array of parameter values given as key-value-pairs and initialise internal member fields accordingly.
 getResultText (SMWQueryResult $res, $outputmode)
 Return serialised results in specified format.

Protected Attributes

 $mOutlineProperties = array()
 $mInnerFormat = ''


Detailed Description

Definition at line 81 of file SRF_Outline.php.


Member Function Documentation

SRFOutline::handleParameters ( array $  params,
outputmode 
) [protected]

Read an array of parameter values given as key-value-pairs and initialise internal member fields accordingly.

Possibly overwritten (extended) by subclasses.

Since:
1.6
Parameters:
array $params
$outputmode 

Reimplemented from SMWResultPrinter.

Definition at line 86 of file SRF_Outline.php.

SRFOutline::getName (  ) 

Get a human readable label for this printer.

The default is to return just the format identifier. Concrete implementations may refer to messages here. The format name is normally not used in wiki text but only in forms etc. hence the user language should be used when retrieving messages.

Returns:
string

Reimplemented from SMWResultPrinter.

Definition at line 91 of file SRF_Outline.php.

SRFOutline::printItem ( item  ) 

Code mostly copied from SMW's SMWListResultPrinter::getResultText().

Definition at line 98 of file SRF_Outline.php.

SRFOutline::printTree ( outline_tree,
level = 0 
)

Definition at line 141 of file SRF_Outline.php.

Referenced by getResultText().

SRFOutline::getResultText ( SMWQueryResult res,
outputmode 
) [protected]

Return serialised results in specified format.

Implemented by subclasses.

Reimplemented from SMWResultPrinter.

Definition at line 177 of file SRF_Outline.php.

References SMWQueryResult::getQueryLink(), SMWResultPrinter::getSearchLabel(), SMWResultPrinter::linkFurtherResults(), and printTree().

SRFOutline::getParameters (  ) 

A function to describe the allowed parameters of a query using any specific format - most query printers should override this function.

TODO: refactor non-printer params up to the query processor and do all param handling there.

Since:
1.5
Returns:
array of Parameter

Reimplemented from SMWResultPrinter.

Definition at line 229 of file SRF_Outline.php.

References SMWResultPrinter::$params.


Member Data Documentation

SRFOutline::$mOutlineProperties = array() [protected]

Definition at line 83 of file SRF_Outline.php.

SRFOutline::$mInnerFormat = '' [protected]

Definition at line 84 of file SRF_Outline.php.


The documentation for this class was generated from the following file:

Generated on Sun Mar 18 07:15:45 2012 for Semantic MediaWiki by  doxygen 1.5.6