MediaWiki master
PrimaryAuthenticationProvider.php
Go to the documentation of this file.
1<?php
24namespace MediaWiki\Auth;
25
28use StatusValue;
29
78 public const TYPE_CREATE = 'create';
80 public const TYPE_LINK = 'link';
82 public const TYPE_NONE = 'none';
83
90 public function getAuthenticationRequests( $action, array $options );
91
105 public function beginPrimaryAuthentication( array $reqs );
106
116 public function continuePrimaryAuthentication( array $reqs );
117
131 public function postAuthentication( $user, AuthenticationResponse $response );
132
142 public function testUserExists( $username, $flags = IDBAccessObject::READ_NORMAL );
143
153 public function testUserCanAuthenticate( $username );
154
175 public function providerNormalizeUsername( $username );
176
188 public function providerRevokeAccessForUser( $username );
189
196 public function providerAllowsPropertyChange( $property );
197
212 AuthenticationRequest $req, $checkData = true
213 );
214
231
236 public function accountCreationType();
237
252 public function testForAccountCreation( $user, $creator, array $reqs );
253
271 public function beginPrimaryAccountCreation( $user, $creator, array $reqs );
272
287 public function continuePrimaryAccountCreation( $user, $creator, array $reqs );
288
306 public function finishAccountCreation( $user, $creator, AuthenticationResponse $response );
307
324 public function postAccountCreation( $user, $creator, AuthenticationResponse $response );
325
344 public function testUserForCreation( $user, $autocreate, array $options = [] );
345
354 public function autoCreatedAccount( $user, $source );
355
371 public function beginPrimaryAccountLink( $user, array $reqs );
372
385 public function continuePrimaryAccountLink( $user, array $reqs );
386
399 public function postAccountLink( $user, AuthenticationResponse $response );
400
401}
This is a value object for authentication requests.
This is a value object to hold authentication response data.
internal since 1.36
Definition User.php:93
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Interface for database access objects.
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)
Return the applicable list of AuthenticationRequests.Possible values for $action depend on whether th...
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=IDBAccessObject::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