Semantic MediaWiki and related extensions
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
SMW\Query\ResultPrinters\ListResultPrinter Class Reference
Inheritance diagram for SMW\Query\ResultPrinters\ListResultPrinter:
Inheritance graph
[legend]
Collaboration diagram for SMW\Query\ResultPrinters\ListResultPrinter:
Collaboration graph
[legend]

Public Member Functions

 getName ()
 
 isDeferrable ()
 
 supportsRecursiveAnnotation ()
 
 getParamDefinitions (array $definitions)
 
- Public Member Functions inherited from SMW\Query\ResultPrinters\ResultPrinter
 __construct ( $format, $inline=true)
 
 msg ()
 
 setRecursiveTextProcessor (RecursiveTextProcessor $recursiveTextProcessor)
 
 isEnabledFeature ( $feature)
 
 copyParser ()
 
 registerResources (array $modules=[], array $styleModules=[])
 
 getQueryMode ( $context)
 
 getName ()
 
 setShowErrors ( $show)
 
 getParameters ()
 
 getParamDefinitions (array $definitions)
 
 isExportFormat ()
 
 isDeferrable ()
 
 supportsRecursiveAnnotation ()
 
 getDefaultSort ()
 
- Public Member Functions inherited from SMW\Query\ResultPrinter
 getResult (QueryResult $results, array $fullParams, $outputMode)
 

Public Attributes

trait ParameterDictionaryUser
 
- Public Attributes inherited from SMW\Query\ResultPrinters\ResultPrinter
const DEFERRED_DATA = 'deferred.data'
 

Protected Member Functions

 getResultText (SMWQueryResult $queryResult, $outputMode)
 
- Protected Member Functions inherited from SMW\Query\ResultPrinters\ResultPrinter
 getResultText (QueryResult $res, $outputMode)
 
 buildResult (QueryResult $results)
 
 handleNonFileResult ( $result, QueryResult $results, $outputmode)
 
 handleParameters (array $params, $outputMode)
 
 postProcessParameters ()
 
 getLinker ( $firstcol=false)
 
 getLink (QueryResult $res, $outputMode, $classAffix='')
 
 getFurtherResultsLink (QueryResult $res, $outputMode)
 
 getErrorString (QueryResult $res)
 
 getResources ()
 
 escapeText ( $text, $outputmode)
 
 getSearchLabel ( $outputmode)
 
 linkFurtherResults (QueryResult $results)
 
 addError ( $errorMessage)
 

Additional Inherited Members

- Static Public Attributes inherited from SMW\Query\ResultPrinters\ResultPrinter
static $maxRecursionDepth = 2
 
- Protected Attributes inherited from SMW\Query\ResultPrinters\ResultPrinter
 $params
 
 $fullParams
 
 $outputMode
 
 $results
 
 $mIntro = ''
 
 $mOutro = ''
 
 $mSearchlabel = null
 
 $mDefault = ''
 
 $mFormat
 
 $mLinkFirst
 
 $mLinkOthers
 
 $mShowHeaders = SMW_HEADERS_SHOW
 
 $mShowErrors = true
 
 $mInline
 
 $mLinker
 
 $mErrors = []
 
 $isHTML = false
 
 $hasTemplates = false
 
 $recursiveTextProcessor
 
 $transcludeAnnotation = true
 

Detailed Description

Print query results in lists.

GNU GPL v2+

Author
Markus Krötzsch SMW's printer for results in lists. The implementation covers comma-separated lists, ordered and unordered lists. List items may be formatted using templates.

In the code below, one list item (with all extra information displayed for it) is called a "row", while one entry in this row is called a "field". Every field may in turn contain many "values".

Member Function Documentation

◆ getName()

SMW\Query\ResultPrinters\ListResultPrinter::getName ( )

Get a human readable label for this printer.

Returns
string

Implements SMW\Query\ResultPrinter.

◆ getParamDefinitions()

SMW\Query\ResultPrinters\ListResultPrinter::getParamDefinitions ( array  $definitions)
See also
SMWIResultPrinter::getParamDefinitions
Since
3.0
Parameters
ParamDefinition[]$definitions
Returns
ParamDefinition[]
Exceptions

Implements SMW\Query\ResultPrinter.

◆ getResultText()

SMW\Query\ResultPrinters\ListResultPrinter::getResultText ( SMWQueryResult  $queryResult,
  $outputMode 
)
protected
See also
ResultPrinter::getResultText
Parameters
SMWQueryResult$queryResult
$outputMode
Returns
string

◆ isDeferrable()

SMW\Query\ResultPrinters\ListResultPrinter::isDeferrable ( )

◆ supportsRecursiveAnnotation()

SMW\Query\ResultPrinters\ListResultPrinter::supportsRecursiveAnnotation ( )
Since
3.0
Returns
boolean

Member Data Documentation

◆ ParameterDictionaryUser

trait SMW\Query\ResultPrinters\ListResultPrinter::ParameterDictionaryUser
Initial value:
{
private $configuration

Class RowBuilder

GNU GPL v2+

Since
3.0
Author
Stephan Gambke

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

About | General disclaimer | Privacy policy