AuthenticationResponse.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Auth;

use Message;

class AuthenticationResponse {
    const PASS = 'PASS';

    const FAIL = 'FAIL';

    const RESTART = 'RESTART';

    const ABSTAIN = 'ABSTAIN';

    const UI = 'UI';

    const REDIRECT = 'REDIRECT';

    public $status;

    public $redirectTarget = null;

    public $redirectApiData = null;

    public $neededRequests = [];

    public $message = null;

    public $messageType = 'warning';

    public $username = null;

    public $createRequest = null;

    public $linkRequest = null;

    public $loginRequest = null;

    public static function newPass( $username = null ) {
        $ret = new AuthenticationResponse;
        $ret->status = AuthenticationResponse::PASS;
        $ret->username = $username;
        return $ret;
    }

    public static function newFail( Message $msg ) {
        $ret = new AuthenticationResponse;
        $ret->status = AuthenticationResponse::FAIL;
        $ret->message = $msg;
        $ret->messageType = 'error';
        return $ret;
    }

    public static function newRestart( Message $msg ) {
        $ret = new AuthenticationResponse;
        $ret->status = AuthenticationResponse::RESTART;
        $ret->message = $msg;
        return $ret;
    }

    public static function newAbstain() {
        $ret = new AuthenticationResponse;
        $ret->status = AuthenticationResponse::ABSTAIN;
        return $ret;
    }

    public static function newUI( array $reqs, Message $msg, $msgtype = 'warning' ) {
        if ( !$reqs ) {
            throw new \InvalidArgumentException( '$reqs may not be empty' );
        }
        if ( $msgtype !== 'warning' && $msgtype !== 'error' ) {
            throw new \InvalidArgumentException( $msgtype . ' is not a valid message type.' );
        }

        $ret = new AuthenticationResponse;
        $ret->status = AuthenticationResponse::UI;
        $ret->neededRequests = $reqs;
        $ret->message = $msg;
        $ret->messageType = $msgtype;
        return $ret;
    }

    public static function newRedirect( array $reqs, $redirectTarget, $redirectApiData = null ) {
        if ( !$reqs ) {
            throw new \InvalidArgumentException( '$reqs may not be empty' );
        }

        $ret = new AuthenticationResponse;
        $ret->status = AuthenticationResponse::REDIRECT;
        $ret->neededRequests = $reqs;
        $ret->redirectTarget = $redirectTarget;
        $ret->redirectApiData = $redirectApiData;
        return $ret;
    }

}