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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\FileRepo;
/**
* 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
* @ingroup FileRepo
* @stable to implement
*/
interface IForeignRepoWithMWApi {
/**
* Make an API query in the foreign repo, caching results
*
* @note action=query, format=json, redirects=true and uselang are automatically set.
* @param array $query Fields to pass to the query
* @return array|null
* @since 1.38
*/
public function fetchImageQuery( $query );
}
/** @deprecated class alias since 1.44 */
class_alias( IForeignRepoWithMWApi::class, 'IForeignRepoWithMWApi' );
|
