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
27 lines
825 B
PHP
27 lines
825 B
PHP
<?php
|
|
|
|
namespace MediaWiki\SpecialPage\Hook;
|
|
|
|
use MediaWiki\Auth\AuthenticationRequest;
|
|
use StatusValue;
|
|
|
|
/**
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
* Use the hook name "ChangeAuthenticationDataAudit" to register handlers implementing this interface.
|
|
*
|
|
* @stable to implement
|
|
* @ingroup Hooks
|
|
*/
|
|
interface ChangeAuthenticationDataAuditHook {
|
|
/**
|
|
* This hook is called when a user changes their password.
|
|
* No return data is accepted; this hook is for auditing only.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param AuthenticationRequest $req Object describing the change (and target user)
|
|
* @param StatusValue $status StatusValue with the result of the action
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onChangeAuthenticationDataAudit( $req, $status );
|
|
}
|