summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/QueryEngine.php
blob: b25541c2b8b78919c7da88e75a2edb324445aaee (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
<?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 );

}