Semantic MediaWiki and related extensions
Protected Member Functions | List of all members
SMW\MediaWiki\Api\Query Class Reference
Inheritance diagram for SMW\MediaWiki\Api\Query:
Inheritance graph
[legend]
Collaboration diagram for SMW\MediaWiki\Api\Query:
Collaboration graph
[legend]

Protected Member Functions

 getQuery ( $queryString, array $printouts, array $parameters=[])
 
 getQueryResult (SMWQuery $query)
 
 addQueryResult (SMWQueryResult $queryResult, $outputFormat='json')
 

Detailed Description

Base for API modules that query SMW

GNU GPL v2+

Since
1.9
Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >
mwjames

Member Function Documentation

◆ addQueryResult()

SMW\MediaWiki\Api\Query::addQueryResult ( SMWQueryResult  $queryResult,
  $outputFormat = 'json' 
)
protected

Add the query result to the API output.

Since
1.6.2
Parameters
SMWQueryResult$queryResult

◆ getQuery()

SMW\MediaWiki\Api\Query::getQuery (   $queryString,
array  $printouts,
array  $parameters = [] 
)
protected

Returns a query object for the provided query string and list of printouts.

Since
1.6.2
Parameters
string$queryString
array$printouts
array$parameters
Returns
SMWQuery

◆ getQueryResult()

SMW\MediaWiki\Api\Query::getQueryResult ( SMWQuery  $query)
protected

Run the actual query and return the result.

Since
1.6.2
Parameters
SMWQuery$query
Returns
SMWQueryResult

The documentation for this class was generated from the following file:

About | General disclaimer | Privacy policy