blob: bb4e3871bd8c4a7894f4082fa85678f589347ca6 (
plain)
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
|
<?php
namespace SMW\Query;
use SMWQueryResult as QueryResult;
/**
* Interface for SMW export related result printers
*
* @license GNU GPL v2+
* @since 1.8
*
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
*/
interface ExportPrinter extends ResultPrinter {
/**
* Outputs the result as file.
*
* @since 1.8
*
* @param QueryResult $queryResult
* @param array $params
*/
public function outputAsFile( QueryResult $queryResult, array $params );
/**
* 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.
*
* @since 1.8
*
* @param QueryResult $queryResult
*
* @return string
*/
public function getMimeType( QueryResult $queryResult );
/**
* 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).
*
* @param QueryResult $queryResult
*
* @return string|boolean
*/
public function getFileName( QueryResult $queryResult );
}
|
