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 | namespace MediaWiki\Hook; |
4 | |
5 | /** |
6 | * This is a hook handler interface, see docs/Hooks.md. |
7 | * Use the hook name "MaintenanceUpdateAddParams" to register handlers implementing this interface. |
8 | * |
9 | * @stable to implement |
10 | * @ingroup Hooks |
11 | */ |
12 | interface MaintenanceUpdateAddParamsHook { |
13 | /** |
14 | * Use this hook to add params to the update.php maintenance script. |
15 | * |
16 | * @since 1.35 |
17 | * |
18 | * @param array &$params Array to populate with the params to be added. Array elements are keyed by |
19 | * the param name. Each param is an associative array that must include the following keys: |
20 | * - `desc`: The description of the param to show on --help |
21 | * - `require`: Is the param required? Defaults to false if not set. |
22 | * - `withArg`: Is an argument required with this option? Defaults to false if not set. |
23 | * - `shortName`: Character to use as short name, or false if none. Defaults to false if not set. |
24 | * - `multiOccurrence`: Can this option be passed multiple times? Defaults to false if not set. |
25 | * @return bool|void True or no return value to continue or false to abort |
26 | */ |
27 | public function onMaintenanceUpdateAddParams( &$params ); |
28 | } |