Public Member Functions | |
| getName () | |
| getParamDefinitions (array $definitions) | |
| getResult (SMWQueryResult $result, array $parameters, $outputMode) | |
| getQueryMode ( $context) | |
| setShowErrors ( $show) | |
| isExportFormat () | |
| getDefaultSort () | |
| isDeferrable () | |
| supportsRecursiveAnnotation () | |
| setRecursiveTextProcessor (RecursiveTextProcessor $recursiveTextProcessor) | |
 Public Member Functions inherited from SMW\Query\ResultPrinter | |
| getResult (QueryResult $results, array $fullParams, $outputMode) | |
Member Function Documentation
◆ getName()
| ModernTimeline\ModernTimelinePrinter::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()
| ModernTimeline\ModernTimelinePrinter::getParamDefinitions | ( | array | $definitions | ) |
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.
◆ getQueryMode()
| ModernTimeline\ModernTimelinePrinter::getQueryMode | ( | $context | ) |
This function determines the query mode that is to be used for this printer in various contexts. The query mode influences how queries to that printer should be processed to obtain a result. Possible values are SMWQuery::MODE_INSTANCES (retrieve instances), SMWQuery::MODE_NONE (do nothing), SMWQuery::MODE_COUNT (get number of results), SMWQuery::MODE_DEBUG (return debugging text). Possible values for context are SMWQueryProcessor::SPECIAL_PAGE, SMWQueryProcessor::INLINE_QUERY, SMWQueryProcessor::CONCEPT_DESC.
The default implementation always returns SMWQuery::MODE_INSTANCES. File exports like RSS will use MODE_INSTANCES on special pages (so that instances are retrieved for the export) and MODE_NONE otherwise (displaying just a download link).
- Parameters
-
$context
- Returns
- integer
Implements SMW\Query\ResultPrinter.
◆ getResult()
| ModernTimeline\ModernTimelinePrinter::getResult | ( | SMWQueryResult | $result, |
| array | $parameters, | ||
| $outputMode | |||
| ) |
- Parameters
-
SMWQueryResult $result Param[] $parameters int $outputMode
- Returns
- string
◆ isExportFormat()
| ModernTimeline\ModernTimelinePrinter::isExportFormat | ( | ) |
Returns if the format is an export format.
- Since
- 1.8
- Returns
- boolean
Implements SMW\Query\ResultPrinter.
◆ setShowErrors()
| ModernTimeline\ModernTimelinePrinter::setShowErrors | ( | $show | ) |
Set whether errors should be shown. By default they are.
- Parameters
-
boolean $show
Implements SMW\Query\ResultPrinter.
The documentation for this class was generated from the following file:
- ModernTimelinePrinter.php
