Semantic MediaWiki and related extensions
Public Member Functions | Protected Member Functions | List of all members
SRF\Formats\Tree\TreeResultPrinter Class Reference
Inheritance diagram for SRF\Formats\Tree\TreeResultPrinter:
Inheritance graph
[legend]
Collaboration diagram for SRF\Formats\Tree\TreeResultPrinter:
Collaboration graph
[legend]

Public Member Functions

 getName ()
 
 getQueryResult ()
 
 setQueryResult ( $queryResult)
 
 getTemplateCall ( $templateName, $params=[])
 
 getParamDefinitions (array $definitions)
 
 getLinker ( $firstcol=false)
 
 getLinkerForColumn ( $column)
 

Protected Member Functions

 postProcessParameters ()
 
 getResultText (SMWQueryResult $queryResult, $outputmode)
 
 buildTreeFromQueryResult ( $rootHash)
 
 getRootHash ()
 
 buildTreeFromNodeList ( $rootHash, $nodes)
 
 buildLinesFromTree ( $tree)
 
 addError ( $msgkey, $params=[])
 

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

◆ addError()

SRF\Formats\Tree\TreeResultPrinter::addError (   $msgkey,
  $params = [] 
)
protected
Parameters
string$msgkey
string| string[] $params

◆ buildLinesFromTree()

SRF\Formats\Tree\TreeResultPrinter::buildLinesFromTree (   $tree)
protected
Parameters
TreeNode$tree
Returns
mixed

◆ buildTreeFromNodeList()

SRF\Formats\Tree\TreeResultPrinter::buildTreeFromNodeList (   $rootHash,
  $nodes 
)
protected
Parameters
string$rootHash
TreeNode[]$nodes
Returns
TreeNode
Exceptions

◆ buildTreeFromQueryResult()

SRF\Formats\Tree\TreeResultPrinter::buildTreeFromQueryResult (   $rootHash)
protected
Parameters
string$rootHash
Returns
TreeNode

◆ getLinker()

SRF\Formats\Tree\TreeResultPrinter::getLinker (   $firstcol = false)

Returns a linker object for making hyperlinks

Returns

◆ getLinkerForColumn()

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

◆ getName()

SRF\Formats\Tree\TreeResultPrinter::getName ( )

(non-PHPdoc)

See also
SMWResultPrinter::getName()

◆ getParamDefinitions()

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

◆ getQueryResult()

SRF\Formats\Tree\TreeResultPrinter::getQueryResult ( )
Returns
SMWQueryResult
Exceptions
Exception

◆ getResultText()

SRF\Formats\Tree\TreeResultPrinter::getResultText ( SMWQueryResult  $queryResult,
  $outputmode 
)
protected

Return serialised results in specified format.

Parameters
SMWQueryResult$queryResult
$outputmode
Returns
string

◆ getRootHash()

SRF\Formats\Tree\TreeResultPrinter::getRootHash ( )
protected
Returns
string | false

◆ getTemplateCall()

SRF\Formats\Tree\TreeResultPrinter::getTemplateCall (   $templateName,
  $params = [] 
)
Parameters
string$templateName
string[]$params
Returns
string

◆ postProcessParameters()

SRF\Formats\Tree\TreeResultPrinter::postProcessParameters ( )
protected
See also
ResultPrinter::postProcessParameters()

◆ setQueryResult()

SRF\Formats\Tree\TreeResultPrinter::setQueryResult (   $queryResult)
Parameters
SMWQueryResult  |  null$queryResult

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

About | General disclaimer | Privacy policy