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