MediaWiki  master
PrimaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
24 namespace MediaWiki\Auth;
25 
26 use StatusValue;
27 use 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 
130  public function postAuthentication( $user, AuthenticationResponse $response );
131 
141  public function testUserExists( $username, $flags = User::READ_NORMAL );
142 
152  public function testUserCanAuthenticate( $username );
153 
174  public function providerNormalizeUsername( $username );
175 
187  public function providerRevokeAccessForUser( $username );
188 
195  public function providerAllowsPropertyChange( $property );
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 
398  public function postAccountLink( $user, AuthenticationResponse $response );
399 
400 }
MediaWiki\Auth\PrimaryAuthenticationProvider\accountCreationType
accountCreationType()
Fetch the account-creation type.
MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_CREATE
const TYPE_CREATE
Provider can create accounts.
Definition: PrimaryAuthenticationProvider.php:77
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_NONE
const TYPE_NONE
Provider cannot create or link to accounts.
Definition: PrimaryAuthenticationProvider.php:81
$response
$response
Definition: opensearch_desc.php:38
MediaWiki\Auth\PrimaryAuthenticationProvider\testForAccountCreation
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
MediaWiki\Auth\PrimaryAuthenticationProvider\testUserForCreation
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
MediaWiki\Auth\PrimaryAuthenticationProvider\postAccountCreation
postAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_LINK
const TYPE_LINK
Provider can link to existing accounts elsewhere.
Definition: PrimaryAuthenticationProvider.php:79
MediaWiki\Auth\PrimaryAuthenticationProvider\continuePrimaryAuthentication
continuePrimaryAuthentication(array $reqs)
Continue an authentication flow.
MediaWiki\Auth\PrimaryAuthenticationProvider\testUserCanAuthenticate
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
MediaWiki\Auth\PrimaryAuthenticationProvider\autoCreatedAccount
autoCreatedAccount( $user, $source)
Post-auto-creation callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerAllowsPropertyChange
providerAllowsPropertyChange( $property)
Determine whether a property can change.
MediaWiki\Auth\PrimaryAuthenticationProvider\postAccountLink
postAccountLink( $user, AuthenticationResponse $response)
Post-link callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerChangeAuthenticationData
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
MediaWiki\Auth\AuthenticationResponse
This is a value object to hold authentication response data.
Definition: AuthenticationResponse.php:37
MediaWiki\Auth\PrimaryAuthenticationProvider\postAuthentication
postAuthentication( $user, AuthenticationResponse $response)
Post-login callback.
MediaWiki\Auth\PrimaryAuthenticationProvider\testUserExists
testUserExists( $username, $flags=User::READ_NORMAL)
Test whether the named user exists.
MediaWiki\Auth\PrimaryAuthenticationProvider\continuePrimaryAccountCreation
continuePrimaryAccountCreation( $user, $creator, array $reqs)
Continue an account creation flow.
MediaWiki\Auth\PrimaryAuthenticationProvider\beginPrimaryAuthentication
beginPrimaryAuthentication(array $reqs)
Start an authentication flow.
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\beginPrimaryAccountLink
beginPrimaryAccountLink( $user, array $reqs)
Start linking an account to an existing user.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerNormalizeUsername
providerNormalizeUsername( $username)
Normalize the username for authentication.
MediaWiki\Auth\PrimaryAuthenticationProvider\providerRevokeAccessForUser
providerRevokeAccessForUser( $username)
Revoke the user's credentials.
MediaWiki\$action
string $action
Cache what action this request is.
Definition: MediaWiki.php:42
MediaWiki\Auth\PrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
MediaWiki\Auth\PrimaryAuthenticationProvider\beginPrimaryAccountCreation
beginPrimaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
$source
$source
Definition: mwdoc-filter.php:34
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:52
MediaWiki\Auth\PrimaryAuthenticationProvider
A primary authentication provider is responsible for associating the submitted authentication data wi...
Definition: PrimaryAuthenticationProvider.php:75
MediaWiki\Auth
Definition: AbstractAuthenticationProvider.php:22
MediaWiki\Auth\PrimaryAuthenticationProvider\finishAccountCreation
finishAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
MediaWiki\Auth\AuthenticationRequest
This is a value object for authentication requests.
Definition: AuthenticationRequest.php:37
MediaWiki\Auth\PrimaryAuthenticationProvider\continuePrimaryAccountLink
continuePrimaryAccountLink( $user, array $reqs)
Continue linking an account to an existing user.
MediaWiki\Auth\AuthenticationProvider
An AuthenticationProvider is used by AuthManager when authenticating users.
Definition: AuthenticationProvider.php:39