Semantic MediaWiki and related extensions
Public Member Functions | Protected Member Functions | List of all members
SMW\Query\ResultPrinters\CategoryResultPrinter Class Reference
Inheritance diagram for SMW\Query\ResultPrinters\CategoryResultPrinter:
Inheritance graph
[legend]
Collaboration diagram for SMW\Query\ResultPrinters\CategoryResultPrinter:
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)
 

Protected Member Functions

 handleParameters (array $params, $outputmode)
 
 initServices ()
 
 getResultText (QueryResult $res, $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

- Public Attributes inherited from SMW\Query\ResultPrinters\ResultPrinter
const DEFERRED_DATA = 'deferred.data'
 
- 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 alphabetic groups displayed in columns, a la the standard Category pages.

GNU GPL v2+

Since
1.6
Author
David Loomer
Yaron Koren
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Member Function Documentation

◆ getName()

SMW\Query\ResultPrinters\CategoryResultPrinter::getName ( )
See also
ResultPrinter::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

Implements SMW\Query\ResultPrinter.

◆ getParamDefinitions()

SMW\Query\ResultPrinters\CategoryResultPrinter::getParamDefinitions ( array  $definitions)
See also
ResultPrinter::getParamDefinitions

Takes a list of parameter definitions and adds those supported by this result printer. Most result printers should override this method.

Since
1.8
Parameters
ParamDefinition[]$definitions
Returns
array

Implements SMW\Query\ResultPrinter.

◆ getResultText()

SMW\Query\ResultPrinters\CategoryResultPrinter::getResultText ( QueryResult  $res,
  $outputMode 
)
protected

◆ handleParameters()

SMW\Query\ResultPrinters\CategoryResultPrinter::handleParameters ( array  $params,
  $outputmode 
)
protected

◆ initServices()

SMW\Query\ResultPrinters\CategoryResultPrinter::initServices ( )
protected
Since
3.0

◆ isDeferrable()

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

◆ supportsRecursiveAnnotation()

SMW\Query\ResultPrinters\CategoryResultPrinter::supportsRecursiveAnnotation ( )

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

About | General disclaimer | Privacy policy