MediaWiki
master
PrimaryAuthenticationProvider.php
Go to the documentation of this file.
1
<?php
7
namespace
MediaWiki\Auth
;
8
9
use
MediaWiki\User\User
;
10
use
StatusValue
;
11
use
Wikimedia\Rdbms\IDBAccessObject
;
12
58
interface
PrimaryAuthenticationProvider
extends
AuthenticationProvider
{
60
public
const
TYPE_CREATE
=
'create'
;
62
public
const
TYPE_LINK
=
'link'
;
64
public
const
TYPE_NONE
=
'none'
;
65
72
public
function
getAuthenticationRequests
( $action, array $options );
73
87
public
function
beginPrimaryAuthentication
( array $reqs );
88
99
public
function
continuePrimaryAuthentication
( array $reqs );
100
113
public
function
postAuthentication
( $user,
AuthenticationResponse
$response );
114
124
public
function
testUserExists
( $username, $flags = IDBAccessObject::READ_NORMAL );
125
135
public
function
testUserCanAuthenticate
( $username );
136
157
public
function
providerNormalizeUsername
( $username );
158
170
public
function
providerRevokeAccessForUser
( $username );
171
179
public
function
providerAllowsPropertyChange
( $property );
180
194
public
function
providerAllowsAuthenticationDataChange
(
195
AuthenticationRequest
$req, $checkData =
true
196
);
197
211
public
function
providerChangeAuthenticationData
(
AuthenticationRequest
$req );
212
218
public
function
accountCreationType
();
219
232
public
function
testForAccountCreation
( $user, $creator, array $reqs );
233
250
public
function
beginPrimaryAccountCreation
( $user, $creator, array $reqs );
251
264
public
function
continuePrimaryAccountCreation
( $user, $creator, array $reqs );
265
281
public
function
finishAccountCreation
( $user, $creator,
AuthenticationResponse
$response );
282
297
public
function
postAccountCreation
( $user, $creator,
AuthenticationResponse
$response );
298
320
public
function
testUserForCreation
( $user, $autocreate, array $options = [] );
321
330
public
function
autoCreatedAccount
( $user,
$source
);
331
347
public
function
beginPrimaryAccountLink
( $user, array $reqs );
348
361
public
function
continuePrimaryAccountLink
( $user, array $reqs );
362
374
public
function
postAccountLink
( $user,
AuthenticationResponse
$response );
375
376
}
MediaWiki\Auth\AuthenticationRequest
This is a value object for authentication requests.
Definition
AuthenticationRequest.php:28
MediaWiki\Auth\AuthenticationResponse
This is a value object to hold authentication response data.
Definition
AuthenticationResponse.php:21
MediaWiki\User\User
User class for the MediaWiki software.
Definition
User.php:130
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition
StatusValue.php:41
MediaWiki\Auth\AuthenticationProvider
Authentication providers are used by AuthManager when authenticating users.
Definition
AuthenticationProvider.php:19
MediaWiki\Auth\PrimaryAuthenticationProvider
Primary authentication providers associate submitted input data with a MediaWiki account.
Definition
PrimaryAuthenticationProvider.php:58
MediaWiki\Auth\PrimaryAuthenticationProvider\getAuthenticationRequests
getAuthenticationRequests( $action, array $options)
Return the applicable list of AuthenticationRequests.Possible values for $action depend on whether th...
MediaWiki\Auth\PrimaryAuthenticationProvider\continuePrimaryAuthentication
continuePrimaryAuthentication(array $reqs)
Continue an authentication flow.
MediaWiki\Auth\PrimaryAuthenticationProvider\autoCreatedAccount
autoCreatedAccount( $user, $source)
Post-auto-creation callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_LINK
const TYPE_LINK
Provider can link to existing accounts elsewhere.
Definition
PrimaryAuthenticationProvider.php:62
MediaWiki\Auth\PrimaryAuthenticationProvider\providerChangeAuthenticationData
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
MediaWiki\Auth\PrimaryAuthenticationProvider\postAccountLink
postAccountLink( $user, AuthenticationResponse $response)
Post-link callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\testUserExists
testUserExists( $username, $flags=IDBAccessObject::READ_NORMAL)
Test whether the named user exists.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerNormalizeUsername
providerNormalizeUsername( $username)
Normalize the username for authentication.
MediaWiki\Auth\PrimaryAuthenticationProvider\beginPrimaryAccountLink
beginPrimaryAccountLink( $user, array $reqs)
Start linking an account to an existing user.
MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_CREATE
const TYPE_CREATE
Provider can create accounts.
Definition
PrimaryAuthenticationProvider.php:60
MediaWiki\Auth\PrimaryAuthenticationProvider\continuePrimaryAccountLink
continuePrimaryAccountLink( $user, array $reqs)
Continue linking an account to an existing user.
MediaWiki\Auth\PrimaryAuthenticationProvider\beginPrimaryAuthentication
beginPrimaryAuthentication(array $reqs)
Start an authentication flow.
MediaWiki\Auth\PrimaryAuthenticationProvider\beginPrimaryAccountCreation
beginPrimaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
MediaWiki\Auth\PrimaryAuthenticationProvider\finishAccountCreation
finishAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerRevokeAccessForUser
providerRevokeAccessForUser( $username)
Revoke the user's credentials.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerAllowsPropertyChange
providerAllowsPropertyChange( $property)
Determine whether a property can change.
MediaWiki\Auth\PrimaryAuthenticationProvider\accountCreationType
accountCreationType()
Fetch the account-creation type.
MediaWiki\Auth\PrimaryAuthenticationProvider\testUserCanAuthenticate
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
MediaWiki\Auth\PrimaryAuthenticationProvider\postAuthentication
postAuthentication( $user, AuthenticationResponse $response)
Post-login callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_NONE
const TYPE_NONE
Provider cannot create or link to accounts.
Definition
PrimaryAuthenticationProvider.php:64
MediaWiki\Auth\PrimaryAuthenticationProvider\postAccountCreation
postAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\testForAccountCreation
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
MediaWiki\Auth\PrimaryAuthenticationProvider\continuePrimaryAccountCreation
continuePrimaryAccountCreation( $user, $creator, array $reqs)
Continue an account creation flow.
MediaWiki\Auth\PrimaryAuthenticationProvider\testUserForCreation
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
Wikimedia\Rdbms\IDBAccessObject
Interface for database access objects.
Definition
IDBAccessObject.php:45
$source
$source
Definition
mwdoc-filter.php:36
MediaWiki\Auth
Definition
AbstractAuthenticationProvider.php:7
includes
Auth
PrimaryAuthenticationProvider.php
Generated on Fri Jan 23 2026 19:24:28 for MediaWiki by
1.10.0