MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
24 namespace MediaWiki\Auth;
26 use Message;
39  const PASS = 'PASS';
42  const FAIL = 'FAIL';
49  const RESTART = 'RESTART';
52  const ABSTAIN = 'ABSTAIN';
55  const UI = 'UI';
58  const REDIRECT = 'REDIRECT';
61  public $status;
64  public $redirectTarget = null;
71  public $redirectApiData = null;
79  public $neededRequests = [];
82  public $message = null;
85  public $messageType = 'warning';
91  public $username = null;
109  public $createRequest = null;
119  public $linkRequest = null;
127  public $loginRequest = null;
134  public static function newPass( $username = null ) {
137  $ret->username = $username;
138  return $ret;
139  }
146  public static function newFail( Message $msg ) {
149  $ret->message = $msg;
150  $ret->messageType = 'error';
151  return $ret;
152  }
159  public static function newRestart( Message $msg ) {
162  $ret->message = $msg;
163  return $ret;
164  }
170  public static function newAbstain() {
173  return $ret;
174  }
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  }
193  $ret->neededRequests = $reqs;
194  $ret->message = $msg;
195  $ret->messageType = $msgtype;
196  return $ret;
197  }
206  public static function newRedirect( array $reqs, $redirectTarget, $redirectApiData = null ) {
207  if ( !$reqs ) {
208  throw new \InvalidArgumentException( '$reqs may not be empty' );
209  }
213  $ret->neededRequests = $reqs;
214  $ret->redirectTarget = $redirectTarget;
215  $ret->redirectApiData = $redirectApiData;
216  return $ret;
217  }
219 }
the array() calling protocol came about after MediaWiki 1.4rc1.
Indicates that the authentication provider does not handle this request.
Indicates that third-party authentication succeeded but no user exists.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1936
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
string $status
One of the constants above.
This is a value object to hold authentication response data.
AuthenticationRequest null $loginRequest
Returned with an AuthManager account creation PASS, this holds a request to pass to AuthManager::begi...
static newRedirect(array $reqs, $redirectTarget, $redirectApiData=null)
string null $redirectTarget
URL to redirect to for a REDIRECT response.
const FAIL
Indicates that the authentication failed.
mixed $redirectApiData
Data for a REDIRECT response that a client might use to query the remote site via its API rather than...
AuthenticationRequest null $linkRequest
When returned with a PrimaryAuthenticationProvider login PASS with no username, the request this hold...
const PASS
Indicates that the authentication succeeded.
string null $username
Local user name from authentication.
Indicates that the authentication needs to be redirected to a third party to proceed.
string $messageType
Whether the $message is an error or warning message, for styling reasons.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
AuthenticationRequest null $createRequest
Returned with a PrimaryAuthenticationProvider login FAIL or a PASS with no username, this can be set to a request that should result in a PASS when passed to that provider's PrimaryAuthenticationProvider::beginPrimaryAccountCreation().
static newUI(array $reqs, Message $msg, $msgtype= 'warning')
AuthenticationRequest[] $neededRequests
Needed AuthenticationRequests to continue after a UI or REDIRECT response.
Message null $message
I18n message to display in case of UI or FAIL.
const UI
Indicates that the authentication needs further user input of some sort.