summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/QueryEngine.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/extensions/SemanticMediaWiki/src/QueryEngine.php')
-rw-r--r--www/wiki/extensions/SemanticMediaWiki/src/QueryEngine.php35
1 files changed, 35 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/src/QueryEngine.php b/www/wiki/extensions/SemanticMediaWiki/src/QueryEngine.php
new file mode 100644
index 00000000..b25541c2
--- /dev/null
+++ b/www/wiki/extensions/SemanticMediaWiki/src/QueryEngine.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace SMW;
+
+use SMWQuery as Query;
+use SMWQueryResult as QueryResult;
+
+/**
+ * Interface for query answering that depend on concrete implementations to
+ * provide the filtering and matching process for specific conditions against a
+ * select back-end.
+ *
+ * @license GNU GPL v2+
+ * @since 2.5
+ *
+ * @author mwjames
+ */
+interface QueryEngine {
+
+ /**
+ * Returns a QueryResult object that matches the condition described by a
+ * query.
+ *
+ * @note If the request was made for a debug (querymode MODE_DEBUG) query
+ * then a simple HTML-compatible string is returned.
+ *
+ * @since 2.5
+ *
+ * @param Query $query
+ *
+ * @return QueryResult|string
+ */
+ public function getQueryResult( Query $query );
+
+}