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 ApiQueryBase; |
6 | use Wikimedia\Rdbms\IResultWrapper; |
7 | |
8 | /** |
9 | * This is a hook handler interface, see docs/Hooks.md. |
10 | * Use the hook name "ApiQueryBaseAfterQuery" to register handlers implementing this interface. |
11 | * |
12 | * @stable to implement |
13 | * @ingroup Hooks |
14 | */ |
15 | interface ApiQueryBaseAfterQueryHook { |
16 | /** |
17 | * This hook is called for (some) API query modules after the |
18 | * database query has returned. An API query module wanting to use this hook |
19 | * should see the ApiQueryBase::select() and ApiQueryBase::processRow() |
20 | * documentation. |
21 | * |
22 | * @since 1.35 |
23 | * |
24 | * @param ApiQueryBase $module Module in question |
25 | * @param IResultWrapper $result ResultWrapper |
26 | * @param array &$hookData Array that was passed to the ApiQueryBaseBeforeQuery hook and |
27 | * will be passed to the ApiQueryBaseProcessRow hook, intended for inter-hook |
28 | * communication |
29 | * @return bool|void True or no return value to continue or false to abort |
30 | */ |
31 | public function onApiQueryBaseAfterQuery( $module, $result, &$hookData ); |
32 | } |