AuthenticationResponse.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Auth;
 
use InvalidArgumentException;
use MediaWiki\Message\Message;
 
class AuthenticationResponse {
    public const PASS = 'PASS';
 
    public const FAIL = 'FAIL';
 
    public const RESTART = 'RESTART';
 
    public const ABSTAIN = 'ABSTAIN';
 
    public const UI = 'UI';
 
    public 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 $failReasons = null;
 
    public static function newPass( $username = null ) {
        $ret = new AuthenticationResponse;
        $ret->status = self::PASS;
        $ret->username = $username;
        return $ret;
    }
 
    public static function newFail( Message $msg, array $failReasons = [] ) {
        $ret = new AuthenticationResponse;
        $ret->status = self::FAIL;
        $ret->message = $msg;
        $ret->messageType = 'error';
        $ret->failReasons = $failReasons;
        return $ret;
    }
 
    public static function newRestart( Message $msg ) {
        $ret = new AuthenticationResponse;
        $ret->status = self::RESTART;
        $ret->message = $msg;
        return $ret;
    }
 
    public static function newAbstain() {
        $ret = new AuthenticationResponse;
        $ret->status = self::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 = self::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 = self::REDIRECT;
        $ret->neededRequests = $reqs;
        $ret->redirectTarget = $redirectTarget;
        $ret->redirectApiData = $redirectApiData;
        return $ret;
    }
 
}