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\Api\Hook; |
4 | |
5 | use ApiQueryWatchlist; |
6 | |
7 | /** |
8 | * This is a hook handler interface, see docs/Hooks.md. |
9 | * Use the hook name "ApiQueryWatchlistPrepareWatchedItemQueryServiceOptions" |
10 | * to register handlers implementing this interface. |
11 | * |
12 | * @stable to implement |
13 | * @ingroup Hooks |
14 | */ |
15 | interface ApiQueryWatchlistPrepareWatchedItemQueryServiceOptionsHook { |
16 | /** |
17 | * Use this hook to populate the options to be passed from ApiQueryWatchlist |
18 | * to WatchedItemQueryService. |
19 | * |
20 | * @since 1.35 |
21 | * |
22 | * @param ApiQueryWatchlist $module |
23 | * @param array $params Array of parameters, as would be returned by |
24 | * $module->extractRequestParams() |
25 | * @param array &$options Array of options for |
26 | * WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo() |
27 | * @return bool|void True or no return value to continue or false to abort |
28 | */ |
29 | public function onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions( |
30 | $module, $params, &$options |
31 | ); |
32 | } |