1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
<?php
namespace SMW\Query;
use SMWQueryResult as QueryResult;
/**
* Interface for SMW result printers.
*
* @license GNU GPL v2+
* @since 1.8
*
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
* @author Markus Krötzsch
*/
interface ResultPrinter {
// Constructor restriction:
// Needs to have exactly one required argument $formatName.
// Is allowed to have additional optional arguments.
/**
* Main entry point: takes an QueryResult and parameters given as key-value-pairs in an array,
* and returns the serialised version of the results, formatted as HTML or Wiki or whatever is
* specified. Normally this is not overwritten by subclasses.
*
* If the outputmode is SMW_OUTPUT_WIKI, then the function will return something that is suitable
* for being used in a MediaWiki parser function, i.e. a wikitext strong *or* an array with flags
* and the string as entry 0. See Parser::setFunctionHook() for documentation on this. In all other
* cases, the function returns just a string.
*
* For outputs SMW_OUTPUT_WIKI and SMW_OUTPUT_HTML, error messages or standard "further results" links
* are directly generated and appended. For SMW_OUTPUT_FILE, only the plain generated text is returned.
*
* @note A note on recursion: some query printers may return wiki code that comes from other pages,
* e.g. from templates that are used in formatting or from embedded result pages. Both kinds of pages
* may contain \#ask queries that do again use new pages, so we must care about recursion. We do so
* by simply counting how often this method starts a subparse and stopping at depth 2. There is one
* special case: if this method is called outside parsing, and the concrete printer returns wiki text,
* and wiki text is requested, then we may return wiki text with sub-queries to the caller. If the
* caller parses this (which is likely) then this will again call us in parse-context and all recursion
* checks catch. Only the first level of parsing is done outside and thus not counted. Thus you
* effectively can get down to level 3. The basic maximal depth of 2 can be changed by setting the
* variable SMWResultPrinter::$maxRecursionDepth (in LocalSettings.php, after enableSemantics()).
* Do this at your own risk.
*
* @param $results QueryResult
* @param $fullParams array
* @param $outputMode integer
*
* @return string
*/
public function getResult( QueryResult $results, array $fullParams, $outputMode );
/**
* 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).
*
* @param $context
*
* @return integer
*/
public function getQueryMode( $context );
/**
* 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.
*
* @return string
*/
public function getName();
/**
* Set whether errors should be shown. By default they are.
*
* @param boolean $show
*/
public function setShowErrors( $show );
/**
* Takes a list of parameter definitions and adds those supported by this
* result printer. Most result printers should override this method.
*
* @since 1.8
*
* @param ParamDefinition[] $definitions
*
* @return array
*/
public function getParamDefinitions( array $definitions );
/**
* Returns if the format is an export format.
*
* @since 1.8
*
* @return boolean
*/
public function isExportFormat();
}
|
