MediaWiki master
IForeignRepoWithMWApi Interface Reference

A foreign repo that implement support for API queries. More...

Inherited by ForeignAPIRepo.

Public Member Functions

 fetchImageQuery ( $query)
 Make an API query in the foreign repo, caching results.
 

Detailed Description

A foreign repo that implement support for API queries.

Extension file repos should implement this if they support making API queries against the foreign repos. Media handler extensions (e.g. TimedMediaHandler) can look for this interface if they need to look up additional information. However, media handler extensions are encouraged to only use direct api calls as a last resort, and try to use other methods to get the information they need instead.

Since
1.38
Stability: stable
to implement

Definition at line 35 of file IForeignRepoWithMWApi.php.

Member Function Documentation

◆ fetchImageQuery()

IForeignRepoWithMWApi::fetchImageQuery ( $query)

Make an API query in the foreign repo, caching results.

Note
action=query, format=json, redirects=true and uselang are automatically set.
Parameters
array$queryFields to pass to the query
Returns
array|null
Since
1.38

Implemented in ForeignAPIRepo.


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