wiki.techinc.nl/includes/api/Hook/ApiQueryBaseAfterQueryHook.php
daniel e6e0ad2472 Replace "@stable for implementation" with "@stable to implement"
For compliance with the new version of the table interface policy
(T255803).

This patch was created by an automated search & replace operation
on the includes/ directory.

Bug: T257789
Change-Id: I17e5e92e24c708ffc846945a136347670a3a20c7
2020-07-13 11:05:49 +02:00

29 lines
943 B
PHP

<?php
namespace MediaWiki\Api\Hook;
use ApiQueryBase;
use Wikimedia\Rdbms\IResultWrapper;
/**
* @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|bool $result ResultWrapper or bool returned from the IDatabase::select()
* @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 );
}