BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
SRF\Formats\Tree\TreeResultPrinter Class Reference
Inheritance diagram for SRF\Formats\Tree\TreeResultPrinter:
Collaboration diagram for SRF\Formats\Tree\TreeResultPrinter:

Public Member Functions

 getName ()
 
 getQueryResult ()
 
 setQueryResult ($queryResult)
 
 getTemplateCall ($templateName, $params=[])
 
 getParamDefinitions (array $definitions)
 
 getLinker ($firstcol=false)
 
 getLinkerForColumn ($column)
 
- Public Member Functions inherited from SMW\ListResultPrinter
 getName ()
 
 getParameters ()
 
- Public Member Functions inherited from SMW\ResultPrinter
 __construct ($format, $inline=true, $useValidator=false)
 
 getQueryMode ($context)
 
 getName ()
 
 setShowErrors ($show)
 
 getParameters ()
 
 getParamDefinitions (array $definitions)
 
 getNamedParameters (array $definitions=array())
 
 isExportFormat ()
 
- Public Member Functions inherited from ContextSource
 getContext ()
 
 setContext (IContextSource $context)
 
 getConfig ()
 
 getRequest ()
 
 getTitle ()
 
 canUseWikiPage ()
 
 getWikiPage ()
 
 getOutput ()
 
 getUser ()
 
 getLanguage ()
 
 getSkin ()
 
 getTiming ()
 
 getStats ()
 
 msg ()
 
 exportSession ()
 
- Public Member Functions inherited from SMW\QueryResultPrinter
 getResult (QueryResult $results, array $fullParams, $outputMode)
 

Protected Member Functions

 postProcessParameters ()
 
 getResultText (SMWQueryResult $queryResult, $outputmode)
 
 buildTreeFromQueryResult ($rootHash)
 
 getRootHash ()
 
 buildTreeFromNodeList ($rootHash, $nodes)
 
 buildLinesFromTree ($tree)
 
 addError ($msgkey, $params=[])
 
- Protected Member Functions inherited from SMW\ListResultPrinter
 handleParameters (array $params, $outputmode)
 
 getResultText (SMWQueryResult $queryResult, $outputMode)
 
 initializePrintingParameters (SMWQueryResult $queryResult)
 
 getRowText (array $row, SMWQueryResult $res)
 
 getRowStart (SMWQueryResult $res)
 
 getRowListContent (array $row)
 
 addTemplateContentFields ($row)
 
 addCommonTemplateFields ($queryResult)
 
 getFurtherResultsText (SMWQueryResult $res, $outputMode)
 
 isPlainlist ()
 
- Protected Member Functions inherited from SMW\ResultPrinter
 getResultText (SMWQueryResult $res, $outputMode)
 
 buildResult (SMWQueryResult $results)
 
 handleParameters (array $params, $outputMode)
 
 postProcessParameters ()
 
 getLinker ($firstcol=false)
 
 getFurtherResultsLink (SMWQueryResult $res, $outputMode)
 
 getErrorString (SMWQueryResult $res)
 
 escapeText ($text, $outputmode)
 
 getSearchLabel ($outputmode)
 
 linkFurtherResults (SMWQueryResult $results)
 
 addError ($errorMessage)
 
 textDisplayParameters ()
 
 exportFormatParameters ()
 

Additional Inherited Members

- Static Public Attributes inherited from SMW\ResultPrinter
static $maxRecursionDepth = 2
 
- Protected Attributes inherited from SMW\ListResultPrinter
 $mTemplate
 
 $mNamedArgs
 
 $mUserParam
 
 $mColumns
 
 $mIntroTemplate
 
 $mOutroTemplate
 
 $header
 
 $footer
 
 $rowstart
 
 $rowend
 
 $listsep
 
 $finallistsep
 
 $columnWidth
 
 $rowsPerColumn
 
 $numRowsInColumn
 
 $numRows
 
- Protected Attributes inherited from SMW\ResultPrinter
 $m_params
 
 $params
 
 $fullParams
 
 $outputMode
 
 $results
 
 $mIntro = ''
 
 $mOutro = ''
 
 $mSearchlabel = null
 
 $mDefault = ''
 
 $mFormat
 
 $mLinkFirst
 
 $mLinkOthers
 
 $mShowHeaders = SMW_HEADERS_SHOW
 
 $mShowErrors = true
 
 $mInline
 
 $mLinker
 
 $mErrors = array()
 
 $isHTML = false
 
 $hasTemplates = false
 

Detailed Description

Result printer that prints query results as a tree (nested html lists).

The available formats are 'tree', 'ultree', 'oltree'. 'tree' is an alias of 'ultree'. In an #ask query the parameter 'parent' must be set to contain the name of the property, that gives the parent page of the subject page.

Member Function Documentation

SRF\Formats\Tree\TreeResultPrinter::addError (   $msgkey,
  $params = [] 
)
protected
Parameters
string$msgkey
string| string[] $params
SRF\Formats\Tree\TreeResultPrinter::buildLinesFromTree (   $tree)
protected
Parameters
$tree
Returns
mixed
SRF\Formats\Tree\TreeResultPrinter::buildTreeFromNodeList (   $rootHash,
  $nodes 
)
protected
Parameters
string$rootHash
TreeNode[]$nodes
Returns
TreeNode
SRF\Formats\Tree\TreeResultPrinter::buildTreeFromQueryResult (   $rootHash)
protected
Parameters
string$rootHash
Returns
TreeNode
SRF\Formats\Tree\TreeResultPrinter::getLinker (   $firstcol = false)

Returns a linker object for making hyperlinks

Returns
SRF\Formats\Tree\TreeResultPrinter::getLinkerForColumn (   $column)

Depending on current linking settings, returns a linker object for making hyperlinks or NULL if no links should be created.

Parameters
int$columnColumn number
Returns
|null
SRF\Formats\Tree\TreeResultPrinter::getName ( )

(non-PHPdoc)

See Also
SMWResultPrinter::getName()

Implements SMW\QueryResultPrinter.

SRF\Formats\Tree\TreeResultPrinter::getParamDefinitions ( array  $definitions)
See Also
SMWResultPrinter::getParamDefinitions
Since
1.8
Parameters
$definitionsarray of IParamDefinition
Returns
array of IParamDefinition|array

Implements SMW\QueryResultPrinter.

SRF\Formats\Tree\TreeResultPrinter::getQueryResult ( )
Returns
SMWQueryResult
Exceptions
Exception
SRF\Formats\Tree\TreeResultPrinter::getResultText ( SMWQueryResult  $queryResult,
  $outputmode 
)
protected

Return serialised results in specified format.

Parameters
SMWQueryResult$queryResult
$outputmode
Returns
string
SRF\Formats\Tree\TreeResultPrinter::getRootHash ( )
protected
Returns
string | false
SRF\Formats\Tree\TreeResultPrinter::getTemplateCall (   $templateName,
  $params = [] 
)
Parameters
string$templateName
string[]$params
Returns
string
SRF\Formats\Tree\TreeResultPrinter::postProcessParameters ( )
protected
SRF\Formats\Tree\TreeResultPrinter::setQueryResult (   $queryResult)
Parameters
SMWQueryResult  |  null$queryResult

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