c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
29 lines
856 B
PHP
29 lines
856 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
// phpcs:disable Generic.Files.LineLength -- Remove this after doc review
|
|
use ApiQueryWatchlist;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface ApiQueryWatchlistPrepareWatchedItemQueryServiceOptionsHook {
|
|
/**
|
|
* Use this hook to populate the options to be passed from ApiQueryWatchlist
|
|
* to WatchedItemQueryService.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param ApiQueryWatchlist $module
|
|
* @param array $params Array of parameters, as would be returned by
|
|
* $module->extractRequestParams()
|
|
* @param array &$options Array of options for
|
|
* WatchedItemQueryService::getWatchedItemsWithRecentChangeInfo()
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onApiQueryWatchlistPrepareWatchedItemQueryServiceOptions(
|
|
$module, $params, &$options
|
|
);
|
|
}
|