PasswordAuthenticationRequest.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Auth;
 
use MediaWiki\Language\RawMessage;
 
class PasswordAuthenticationRequest extends AuthenticationRequest {
    public $password = null;
 
    public $retype = null;
 
    public function getFieldInfo() {
        if ( $this->action === AuthManager::ACTION_REMOVE ) {
            return [];
        }
 
        // for password change it's nice to make extra clear that we are asking for the new password
        $forNewPassword = $this->action === AuthManager::ACTION_CHANGE;
        $passwordLabel = $forNewPassword ? 'newpassword' : 'userlogin-yourpassword';
        $retypeLabel = $forNewPassword ? 'retypenew' : 'yourpasswordagain';
 
        $ret = [
            'username' => [
                'type' => 'string',
                'label' => wfMessage( 'userlogin-yourname' ),
                'help' => wfMessage( 'authmanager-username-help' ),
            ],
            'password' => [
                'type' => 'password',
                'label' => wfMessage( $passwordLabel ),
                'help' => wfMessage( 'authmanager-password-help' ),
                'sensitive' => true,
            ],
        ];
 
        switch ( $this->action ) {
            case AuthManager::ACTION_CHANGE:
            case AuthManager::ACTION_REMOVE:
                unset( $ret['username'] );
                break;
        }
 
        if ( $this->action !== AuthManager::ACTION_LOGIN ) {
            $ret['retype'] = [
                'type' => 'password',
                'label' => wfMessage( $retypeLabel ),
                'help' => wfMessage( 'authmanager-retype-help' ),
                'sensitive' => true,
            ];
        }
 
        return $ret;
    }
 
    public function describeCredentials() {
        return [
            'provider' => wfMessage( 'authmanager-provider-password' ),
            'account' => new RawMessage( '$1', [ $this->username ] ),
        ];
    }
}