MediaWiki REL1_37
|
Simple SPARQL client. More...
Public Member Functions | |
__construct ( $url, HttpRequestFactory $requestFactory) | |
appendUserAgent ( $agent) | |
Append specific string to user agent. | |
getUserAgent () | |
Get current user agent. | |
query ( $sparql, $rawData=false) | |
Query SPARQL endpoint. | |
setClientOptions ( $options) | |
setTimeout ( $timeout) | |
Set query timeout (in seconds) | |
setUserAgent ( $agent) | |
Mote it is not recommended to completely override user agent for most applications. | |
Public Attributes | |
const | MAX_GET_SIZE = 2048 |
Limit on how long can be the query to be sent by GET. | |
Private Member Functions | |
extractData ( $data, $rawData=false) | |
Extract data from SPARQL response format. | |
Private Attributes | |
string | $endpoint |
SPARQL endpoint URL. | |
array | $options = [] |
Client options. | |
HttpRequestFactory | $requestFactory |
int | $timeout = 30 |
Query timeout (seconds) | |
string | $userAgent |
User agent for HTTP requests. | |
Simple SPARQL client.
Definition at line 30 of file SparqlClient.php.
MediaWiki\Sparql\SparqlClient::__construct | ( | $url, | |
HttpRequestFactory | $requestFactory | ||
) |
string | $url | SPARQL Endpoint |
HttpRequestFactory | $requestFactory |
Definition at line 70 of file SparqlClient.php.
References MediaWiki\Sparql\SparqlClient\$requestFactory, and MediaWiki\Http\HttpRequestFactory\getUserAgent().
MediaWiki\Sparql\SparqlClient::appendUserAgent | ( | $agent | ) |
Append specific string to user agent.
This is the recommended way of specifying the user agent for specific applications of the SparqlClient inside MediaWiki and extension code.
string | $agent |
Definition at line 125 of file SparqlClient.php.
|
private |
Extract data from SPARQL response format.
The response must be in format described in: https://www.w3.org/TR/sparql11-results-json/
array | $data | SPARQL result |
bool | $rawData | Whether to return only values or full data objects |
Definition at line 193 of file SparqlClient.php.
Referenced by MediaWiki\Sparql\SparqlClient\query().
MediaWiki\Sparql\SparqlClient::getUserAgent | ( | ) |
Get current user agent.
Definition at line 101 of file SparqlClient.php.
References MediaWiki\Sparql\SparqlClient\$userAgent.
MediaWiki\Sparql\SparqlClient::query | ( | $sparql, | |
$rawData = false |
|||
) |
Query SPARQL endpoint.
string | $sparql | query |
bool | $rawData | Whether to return only values or full data objects |
SparqlException |
Definition at line 139 of file SparqlClient.php.
References MediaWiki\Sparql\SparqlClient\$options, MediaWiki\Sparql\SparqlClient\$timeout, MediaWiki\Sparql\SparqlClient\$userAgent, MediaWiki\Sparql\SparqlClient\extractData(), and wfAppendQuery().
MediaWiki\Sparql\SparqlClient::setClientOptions | ( | $options | ) |
array | $options |
Definition at line 92 of file SparqlClient.php.
References MediaWiki\Sparql\SparqlClient\$options.
MediaWiki\Sparql\SparqlClient::setTimeout | ( | $timeout | ) |
Set query timeout (in seconds)
int | $timeout |
Definition at line 81 of file SparqlClient.php.
References MediaWiki\Sparql\SparqlClient\$timeout.
MediaWiki\Sparql\SparqlClient::setUserAgent | ( | $agent | ) |
Mote it is not recommended to completely override user agent for most applications.
string | $agent |
Definition at line 112 of file SparqlClient.php.
|
private |
SPARQL endpoint URL.
Definition at line 53 of file SparqlClient.php.
|
private |
Client options.
Definition at line 59 of file SparqlClient.php.
Referenced by MediaWiki\Sparql\SparqlClient\query(), and MediaWiki\Sparql\SparqlClient\setClientOptions().
|
private |
Definition at line 64 of file SparqlClient.php.
Referenced by MediaWiki\Sparql\SparqlClient\__construct().
|
private |
Query timeout (seconds)
Definition at line 47 of file SparqlClient.php.
Referenced by MediaWiki\Sparql\SparqlClient\query(), and MediaWiki\Sparql\SparqlClient\setTimeout().
|
private |
User agent for HTTP requests.
Definition at line 41 of file SparqlClient.php.
Referenced by MediaWiki\Sparql\SparqlClient\getUserAgent(), and MediaWiki\Sparql\SparqlClient\query().
const MediaWiki\Sparql\SparqlClient::MAX_GET_SIZE = 2048 |
Limit on how long can be the query to be sent by GET.
Definition at line 35 of file SparqlClient.php.