MediaWiki REL1_37
AuthenticationResponse.php
Go to the documentation of this file.
1<?php
24namespace MediaWiki\Auth;
25
26use Message;
27
39 public const PASS = 'PASS';
40
42 public const FAIL = 'FAIL';
43
49 public const RESTART = 'RESTART';
50
52 public const ABSTAIN = 'ABSTAIN';
53
55 public const UI = 'UI';
56
58 public const REDIRECT = 'REDIRECT';
59
61 public $status;
62
64 public $redirectTarget = null;
65
71 public $redirectApiData = null;
72
79 public $neededRequests = [];
80
82 public $message = null;
83
85 public $messageType = 'warning';
86
91 public $username = null;
92
109 public $createRequest = null;
110
119 public $linkRequest = null;
120
127 public $loginRequest = null;
128
134 public static function newPass( $username = null ) {
135 $ret = new AuthenticationResponse;
136 $ret->status = self::PASS;
137 $ret->username = $username;
138 return $ret;
139 }
140
146 public static function newFail( Message $msg ) {
147 $ret = new AuthenticationResponse;
148 $ret->status = self::FAIL;
149 $ret->message = $msg;
150 $ret->messageType = 'error';
151 return $ret;
152 }
153
159 public static function newRestart( Message $msg ) {
160 $ret = new AuthenticationResponse;
161 $ret->status = self::RESTART;
162 $ret->message = $msg;
163 return $ret;
164 }
165
170 public static function newAbstain() {
171 $ret = new AuthenticationResponse;
172 $ret->status = self::ABSTAIN;
173 return $ret;
174 }
175
183 public static function newUI( array $reqs, Message $msg, $msgtype = 'warning' ) {
184 if ( !$reqs ) {
185 throw new \InvalidArgumentException( '$reqs may not be empty' );
186 }
187 if ( $msgtype !== 'warning' && $msgtype !== 'error' ) {
188 throw new \InvalidArgumentException( $msgtype . ' is not a valid message type.' );
189 }
190
191 $ret = new AuthenticationResponse;
192 $ret->status = self::UI;
193 $ret->neededRequests = $reqs;
194 $ret->message = $msg;
195 $ret->messageType = $msgtype;
196 return $ret;
197 }
198
206 public static function newRedirect( array $reqs, $redirectTarget, $redirectApiData = null ) {
207 if ( !$reqs ) {
208 throw new \InvalidArgumentException( '$reqs may not be empty' );
209 }
210
211 $ret = new AuthenticationResponse;
212 $ret->status = self::REDIRECT;
213 $ret->neededRequests = $reqs;
214 $ret->redirectTarget = $redirectTarget;
215 $ret->redirectApiData = $redirectApiData;
216 return $ret;
217 }
218
219}
This is a value object for authentication requests.
This is a value object to hold authentication response data.
const FAIL
Indicates that the authentication failed.
const PASS
Indicates that the authentication succeeded.
string null $username
Local user name from authentication.
string null $redirectTarget
URL to redirect to for a REDIRECT response.
AuthenticationRequest null $linkRequest
When returned with a PrimaryAuthenticationProvider login PASS with no username, the request this hold...
const UI
Indicates that the authentication needs further user input of some sort.
static newRedirect(array $reqs, $redirectTarget, $redirectApiData=null)
AuthenticationRequest[] $neededRequests
Needed AuthenticationRequests to continue after a UI or REDIRECT response.
const REDIRECT
Indicates that the authentication needs to be redirected to a third party to proceed.
string $status
One of the constants above.
const ABSTAIN
Indicates that the authentication provider does not handle this request.
Message null $message
I18n message to display in case of UI or FAIL.
mixed $redirectApiData
Data for a REDIRECT response that a client might use to query the remote site via its API rather than...
AuthenticationRequest null $loginRequest
Returned with an AuthManager account creation PASS, this holds a request to pass to AuthManager::begi...
string $messageType
Whether the $message is an error or warning message, for styling reasons.
AuthenticationRequest null $createRequest
Returned with a PrimaryAuthenticationProvider login FAIL or a PASS with no username,...
static newUI(array $reqs, Message $msg, $msgtype='warning')
const RESTART
Indicates that third-party authentication succeeded but no user exists.
The Message class deals with fetching and processing of interface message into a variety of formats.
Definition Message.php:138