Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21/**
22 * A foreign repo that implement support for API queries.
23 *
24 * Extension file repos should implement this if they support making API queries
25 * against the foreign repos. Media handler extensions (e.g. TimedMediaHandler)
26 * can look for this interface if they need to look up additional information.
27 * However, media handler extensions are encouraged to only use direct api calls
28 * as a last resort, and try to use other methods to get the information they
29 * need instead.
30 *
31 * @since 1.38
32 * @ingroup FileRepo
33 * @stable to implement
34 */
35interface IForeignRepoWithMWApi {
36    /**
37     * Make an API query in the foreign repo, caching results
38     *
39     * @note action=query, format=json, redirects=true and uselang are automatically set.
40     * @param array $query Fields to pass to the query
41     * @return array|null
42     * @since 1.38
43     */
44    public function fetchImageQuery( $query );
45}