f5aaf75ad1
Add hook interfaces which were generated by a script which parses
hooks.txt and identifies caller namespaces and directories.
Hook interfaces are mostly placed in a Hook/ subdirectory
relative to the caller location. When there are callers in multiple
directories, a "primary" caller was manually selected. The exceptions to
this are:
* The source root, maintenance and tests, which use includes/Hook. Test
hooks need to be autoloadable in a non-test request so that
implementing test interfaces in a generic handler will not fail.
* resources uses includes/resourceloader/Hook
* The following third-level subdirectories had their hooks placed in
the parent ../Hook:
* includes/filerepo/file
* includes/search/searchwidgets
* includes/specials/forms
* includes/specials/helpers
* includes/specials/pagers
Parameters marked as legacy references in hooks.txt are passed
by value in the interfaces.
Bug: T240307
Change-Id: I6efe2e7dd1f0c6a3d0f4d100a4c34e41f8428720
26 lines
878 B
PHP
26 lines
878 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface ApiQueryBaseAfterQueryHook {
|
|
/**
|
|
* 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 ?mixed $module ApiQueryBase module in question
|
|
* @param ?mixed $result ResultWrapper|bool returned from the IDatabase::select()
|
|
* @param ?mixed &$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 );
|
|
}
|