wiki.techinc.nl/includes/api/Hook/ApiQueryBaseProcessRowHook.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 stdClass;
/**
* @stable to implement
* @ingroup Hooks
*/
interface ApiQueryBaseProcessRowHook {
/**
* This hook is called for (some) API query modules as each row of the database result is
* processed. 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 stdClass $row Database result row
* @param array &$data Array to be included in the ApiResult
* @param array &$hookData Array that was be passed to the ApiQueryBaseBeforeQuery and
* ApiQueryBaseAfterQuery hooks, intended for inter-hook communication
* @return bool|void True or no return value to continue, or false to stop processing the
* result set
*/
public function onApiQueryBaseProcessRow( $module, $row, &$data, &$hookData );
}