1fc8d79ac6
For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
36 lines
1.1 KiB
PHP
36 lines
1.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
use ApiBase;
|
|
use IApiMessage;
|
|
use Message;
|
|
use User;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "ApiCheckCanExecute" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface ApiCheckCanExecuteHook {
|
|
/**
|
|
* This hook is called during ApiMain::checkCanExecute. Use this hook to further
|
|
* authenticate and authorize API clients before executing the module.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param ApiBase $module
|
|
* @param User $user Current user
|
|
* @param IApiMessage|Message|string|array &$message API message to die with.
|
|
* Specific values accepted depend on the MediaWiki version:
|
|
* * 1.29+: IApiMessage, Message, string message key, or key+parameters array to
|
|
* pass to ApiBase::dieWithError().
|
|
* * 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
|
|
* * Earlier: A key or key+parameters in ApiBase::$messageMap.
|
|
* @return bool|void True or no return value to continue, or false and set a
|
|
* message to cancel the request
|
|
*/
|
|
public function onApiCheckCanExecute( $module, $user, &$message );
|
|
}
|