c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
29 lines
949 B
PHP
29 lines
949 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
use ApiQueryBase;
|
|
use stdClass;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @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 );
|
|
}
|