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 | use Wikimedia\Rdbms\IDatabase; |
22 | use Wikimedia\Rdbms\IReadableDatabase; |
23 | |
24 | /** |
25 | * A foreign repo that allows for direct access to the foreign MW database. |
26 | * |
27 | * Extension file repos should implement this if they support making DB queries |
28 | * against the foreign repos. Media handler extensions (e.g. TimedMediaHandler) |
29 | * can look for this interface if they need to look up additional information. |
30 | * |
31 | * An extension will typically implement this by extending the LocalRepo class |
32 | * and overriding these methods. If the foreign repo is meant to be non-writable, |
33 | * the extension should additionally override LocalRepo::assertWritableRepo() and |
34 | * throw an exception -- see ForeignDBRepo and ForeignDBViaLBRepo for examples. |
35 | * |
36 | * @since 1.41 |
37 | * @ingroup FileRepo |
38 | * @stable to implement |
39 | */ |
40 | interface IForeignRepoWithDB { |
41 | /** |
42 | * Get a connection to the primary DB for the foreign repo. |
43 | * @return IDatabase |
44 | * @since 1.41 |
45 | */ |
46 | public function getPrimaryDB(); |
47 | |
48 | /** |
49 | * Get a connection to the replica DB for the foreign repo. |
50 | * @return IReadableDatabase |
51 | * @since 1.41 |
52 | */ |
53 | public function getReplicaDB(); |
54 | } |