1 files changed, 58 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/src/Query/ExportPrinter.php b/www/wiki/extensions/SemanticMediaWiki/src/Query/ExportPrinter.php
new file mode 100644
index 00000000..bb4e3871
--- /dev/null
+++ b/www/wiki/extensions/SemanticMediaWiki/src/Query/ExportPrinter.php
@@ -0,0 +1,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 );
+
+}