41 $resetRoutes = $this->
getConfig()->get(
'PasswordResetRoutes' );
42 $this->
hasAnyRoutes = !empty( $resetRoutes[
'username'] ) || !empty( $resetRoutes[
'email'] );
49 return 'apihelp-resetpassword-extended-description-noroutes';
51 return parent::getExtendedDescription();
56 $this->
dieWithError(
'apihelp-resetpassword-description-noroutes',
'moduledisabled' );
67 $passwordReset = MediaWikiServices::getInstance()->getPasswordReset();
69 $status = $passwordReset->isAllowed( $this->
getUser() );
70 if ( !$status->isOK() ) {
71 $this->
dieStatus( Status::wrap( $status ) );
74 $status = $passwordReset->execute(
75 $this->
getUser(), $params[
'user'], $params[
'email']
77 if ( !$status->isOK() ) {
78 $status->value =
null;
79 $this->
dieStatus( Status::wrap( $status ) );
83 $result->addValue( [
'resetpassword' ],
'status',
'success' );
105 UserDef::PARAM_ALLOWED_USER_TYPES => [
'name' ],
112 $resetRoutes = $this->
getConfig()->get(
'PasswordResetRoutes' );
113 if ( empty( $resetRoutes[
'username'] ) ) {
114 unset( $ret[
'user'] );
116 if ( empty( $resetRoutes[
'email'] ) ) {
117 unset( $ret[
'email'] );
125 $resetRoutes = $this->
getConfig()->get(
'PasswordResetRoutes' );
127 if ( !empty( $resetRoutes[
'username'] ) ) {
128 $ret[
'action=resetpassword&user=Example&token=123ABC'] =
'apihelp-resetpassword-example-user';
130 if ( !empty( $resetRoutes[
'email'] ) ) {
131 $ret[
'action=resetpassword&user=user@example.com&token=123ABC'] =
132 'apihelp-resetpassword-example-email';
139 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Manage_authentication_data';
This abstract class implements many basic API functions, and is the base of all API classes.
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
requireOnlyOneParameter( $params,... $required)
Die if none or more than one of a certain set of parameters is set and not false.
getResult()
Get the result object.
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Reset password, with AuthManager.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getExtendedDescription()
Return the extended help text message.
getExamplesMessages()
Returns usage examples for this module.
isWriteMode()
Indicates whether this module requires write mode.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
needsToken()
Returns the token type this module requires in order to execute.
hasAnyRoutes()
Determine whether any reset routes are available.
getHelpUrls()
Return links to more detailed help pages about the module.
getUser()
Stable to override.