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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
<?php
namespace SMW\MediaWiki\Api;
use ApiBase;
use SMW\ApplicationFactory;
use SMWQuery;
use SMWQueryProcessor;
use SMWQueryResult;
/**
* Base for API modules that query SMW
*
* @ingroup Api
*
* @license GNU GPL v2+
* @since 1.9
*
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
* @author mwjames
*/
abstract class Query extends ApiBase {
/**
* Returns a query object for the provided query string and list of printouts.
*
* @since 1.6.2
*
* @param string $queryString
* @param array $printouts
* @param array $parameters
*
* @return SMWQuery
*/
protected function getQuery( $queryString, array $printouts, array $parameters = [] ) {
SMWQueryProcessor::addThisPrintout( $printouts, $parameters );
$query = SMWQueryProcessor::createQuery(
$queryString,
SMWQueryProcessor::getProcessedParams( $parameters, $printouts ),
SMWQueryProcessor::SPECIAL_PAGE,
'',
$printouts
);
$query->setOption( SMWQuery::PROC_CONTEXT, 'API' );
return $query;
}
/**
* Run the actual query and return the result.
*
* @since 1.6.2
*
* @param SMWQuery $query
*
* @return SMWQueryResult
*/
protected function getQueryResult( SMWQuery $query ) {
return ApplicationFactory::getInstance()->getStore()->getQueryResult( $query );
}
/**
* Add the query result to the API output.
*
* @since 1.6.2
*
* @param SMWQueryResult $queryResult
*/
protected function addQueryResult( SMWQueryResult $queryResult, $outputFormat = 'json' ) {
$result = $this->getResult();
$resultFormatter = new ApiQueryResultFormatter( $queryResult );
$resultFormatter->setIsRawMode( ( strpos( strtolower( $outputFormat ), 'xml' ) !== false ) );
$resultFormatter->doFormat();
if ( $resultFormatter->getContinueOffset() ) {
// $result->disableSizeCheck();
$result->addValue( null, 'query-continue-offset', $resultFormatter->getContinueOffset() );
// $result->enableSizeCheck();
}
$result->addValue(
null,
$resultFormatter->getType(),
$resultFormatter->getResult()
);
}
}
|
