Public Member Functions | |
| getMimeType ($res) | |
| Some printers do not mainly produce embeddable HTML or Wikitext, but produce stand-alone files. | |
| getFileName ($res) | |
| Some printers can produce not only embeddable HTML or Wikitext, but can also produce stand-alone files. | |
| getQueryMode ($context) | |
| This function determines the query mode that is to be used for this printer in various contexts. | |
| getName () | |
| Get a human readable label for this printer. | |
| getParameters () | |
| A function to describe the allowed parameters of a query using any specific format - most query printers should override this function. | |
Protected Member Functions | |
| handleParameters (array $params, $outputmode) | |
| getResultText (SMWQueryResult $res, $outputmode) | |
| Return serialised results in specified format. | |
| getResultFileContents (SMWQueryResult $res) | |
| Returns the query result in DSV. | |
| getDSVLine (array $fields) | |
| Returns a single DSV line. | |
| encodeDSV ($value) | |
| Encodes a single DSV. | |
| getLinkToFile (SMWQueryResult $res, $outputmode) | |
| Returns html for a link to a query that returns the DSV file. | |
Protected Attributes | |
| $separator = ':' | |
| $fileName = 'result.dsv' | |
Definition at line 15 of file SMW_QP_DSV.php.
| SMWDSVResultPrinter::handleParameters | ( | array $ | params, | |
| $ | outputmode | |||
| ) | [protected] |
| array | $params | |
| $outputmode |
Reimplemented from SMWResultPrinter.
Definition at line 28 of file SMW_QP_DSV.php.
| SMWDSVResultPrinter::getMimeType | ( | $ | res | ) |
Some printers do not mainly produce embeddable HTML or Wikitext, but produce stand-alone files.
An example is RSS or iCalendar. This function returns the mimetype string that this file would have, or FALSE if no standalone files are produced.
If this function returns something other than FALSE, then the printer will not be regarded as a printer that displays in-line results. This is used to determine if a file output should be generated in Special:Ask.
Reimplemented from SMWResultPrinter.
Definition at line 39 of file SMW_QP_DSV.php.
| SMWDSVResultPrinter::getFileName | ( | $ | res | ) |
Some printers can produce not only embeddable HTML or Wikitext, but can also produce stand-alone files.
An example is RSS or iCalendar. This function returns a filename that is to be sent to the caller in such a case (the default filename is created by browsers from the URL, and it is often not pretty).
See also SMWResultPrinter::getMimeType()
Reimplemented from SMWResultPrinter.
Definition at line 43 of file SMW_QP_DSV.php.
| SMWDSVResultPrinter::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).
Reimplemented from SMWResultPrinter.
Definition at line 47 of file SMW_QP_DSV.php.
References SMWQuery::MODE_INSTANCES, SMWQuery::MODE_NONE, and SMWQueryProcessor::SPECIAL_PAGE.
| SMWDSVResultPrinter::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.
Reimplemented from SMWResultPrinter.
Definition at line 51 of file SMW_QP_DSV.php.
| SMWDSVResultPrinter::getResultText | ( | SMWQueryResult $ | res, | |
| $ | outputmode | |||
| ) | [protected] |
Return serialised results in specified format.
Implemented by subclasses.
Reimplemented from SMWResultPrinter.
Definition at line 55 of file SMW_QP_DSV.php.
References getLinkToFile(), and getResultFileContents().
| SMWDSVResultPrinter::getResultFileContents | ( | SMWQueryResult $ | res | ) | [protected] |
Returns the query result in DSV.
| SMWQueryResult | $res |
Definition at line 73 of file SMW_QP_DSV.php.
References getDSVLine().
Referenced by getResultText().
| SMWDSVResultPrinter::getDSVLine | ( | array $ | fields | ) | [protected] |
Returns a single DSV line.
| array | $fields |
Definition at line 118 of file SMW_QP_DSV.php.
Referenced by getResultFileContents().
| SMWDSVResultPrinter::encodeDSV | ( | $ | value | ) | [protected] |
Encodes a single DSV.
| string | $value |
Definition at line 131 of file SMW_QP_DSV.php.
| SMWDSVResultPrinter::getLinkToFile | ( | SMWQueryResult $ | res, | |
| $ | outputmode | |||
| ) | [protected] |
Returns html for a link to a query that returns the DSV file.
| SMWQueryResult | $res | |
| $outputmode |
Definition at line 154 of file SMW_QP_DSV.php.
References SMWQueryResult::getQueryLink(), and SMWResultPrinter::getSearchLabel().
Referenced by getResultText().
| SMWDSVResultPrinter::getParameters | ( | ) |
A function to describe the allowed parameters of a query using any specific format - most query printers should override this function.
TODO: refactor non-printer params up to the query processor and do all param handling there.
Reimplemented from SMWResultPrinter.
Definition at line 183 of file SMW_QP_DSV.php.
References SMWResultPrinter::$params, and SMWResultPrinter::exportFormatParameters().
SMWDSVResultPrinter::$separator = ':' [protected] |
Definition at line 17 of file SMW_QP_DSV.php.
SMWDSVResultPrinter::$fileName = 'result.dsv' [protected] |
Definition at line 18 of file SMW_QP_DSV.php.
1.5.6