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
3namespace MediaWiki\Hook;
4
5use Wikimedia\Rdbms\IReadableDatabase;
6
7/**
8 * This is a hook handler interface, see docs/Hooks.md.
9 * Use the hook name "ModifyExportQuery" to register handlers implementing this interface.
10 *
11 * @stable to implement
12 * @ingroup Hooks
13 */
14interface ModifyExportQueryHook {
15    /**
16     * Use this hook to modify the query used by the exporter.
17     *
18     * @since 1.35
19     *
20     * @param IReadableDatabase $db Database object to be queried
21     * @param array &$tables Tables in the query
22     * @param string $cond An SQL fragment included in the WHERE clause which is used to filter
23     *   the results, for example to a specific page. Since 1.31, modification of this
24     *   parameter has no effect. Since 1.35, you can use $conds instead to modify the
25     *   array of conditions passed to IReadableDatabase::select().
26     * @param array &$opts Options for the query
27     * @param array &$join_conds Join conditions for the query
28     * @param array &$conds The array of conditions to be passed to IReadableDatabase::select(). Can be
29     *   modified. Includes the value of $cond.
30     * @return bool|void True or no return value to continue or false to abort
31     */
32    public function onModifyExportQuery( $db, &$tables, $cond, &$opts,
33        &$join_conds, &$conds
34    );
35}