MediaWiki REL1_31
PrimaryAuthenticationProvider.php
Go to the documentation of this file.
1<?php
24namespace MediaWiki\Auth;
25
26use StatusValue;
27use User;
28
77 const TYPE_CREATE = 'create';
79 const TYPE_LINK = 'link';
81 const TYPE_NONE = 'none';
82
89 public function getAuthenticationRequests( $action, array $options );
90
104 public function beginPrimaryAuthentication( array $reqs );
105
115 public function continuePrimaryAuthentication( array $reqs );
116
131
141 public function testUserExists( $username, $flags = User::READ_NORMAL );
142
153
175
188
196
211 AuthenticationRequest $req, $checkData = true
212 );
213
230
235 public function accountCreationType();
236
251 public function testForAccountCreation( $user, $creator, array $reqs );
252
270 public function beginPrimaryAccountCreation( $user, $creator, array $reqs );
271
286 public function continuePrimaryAccountCreation( $user, $creator, array $reqs );
287
305 public function finishAccountCreation( $user, $creator, AuthenticationResponse $response );
306
323 public function postAccountCreation( $user, $creator, AuthenticationResponse $response );
324
343 public function testUserForCreation( $user, $autocreate, array $options = [] );
344
353 public function autoCreatedAccount( $user, $source );
354
370 public function beginPrimaryAccountLink( $user, array $reqs );
371
384 public function continuePrimaryAccountLink( $user, array $reqs );
385
399
400}
This is a value object for authentication requests.
This is a value object to hold authentication response data.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:53
this hook is for auditing only $req
Definition hooks.txt:990
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 & $options
Definition hooks.txt:2001
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:785
this hook is for auditing only $response
Definition hooks.txt:783
An AuthenticationProvider is used by AuthManager when authenticating users.
A primary authentication provider is responsible for associating the submitted authentication data wi...
getAuthenticationRequests( $action, array $options)
@inheritDoc
continuePrimaryAuthentication(array $reqs)
Continue an authentication flow.
autoCreatedAccount( $user, $source)
Post-auto-creation callback.
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
const TYPE_LINK
Provider can link to existing accounts elsewhere.
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
postAccountLink( $user, AuthenticationResponse $response)
Post-link callback.
testUserExists( $username, $flags=User::READ_NORMAL)
Test whether the named user exists.
providerNormalizeUsername( $username)
Normalize the username for authentication.
beginPrimaryAccountLink( $user, array $reqs)
Start linking an account to an existing user.
continuePrimaryAccountLink( $user, array $reqs)
Continue linking an account to an existing user.
beginPrimaryAuthentication(array $reqs)
Start an authentication flow.
beginPrimaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
finishAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
providerRevokeAccessForUser( $username)
Revoke the user's credentials.
providerAllowsPropertyChange( $property)
Determine whether a property can change.
accountCreationType()
Fetch the account-creation type.
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
postAuthentication( $user, AuthenticationResponse $response)
Post-login callback.
const TYPE_NONE
Provider cannot create or link to accounts.
postAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
continuePrimaryAccountCreation( $user, $creator, array $reqs)
Continue an account creation flow.
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
$source
$property