MediaWiki REL1_32
PrimaryAuthenticationProvider.php
Go to the documentation of this file.
1<?php
24namespace MediaWiki\Auth;
25
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}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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:47
this hook is for auditing only $req
Definition hooks.txt:1018
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:2050
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:815
this hook is for auditing only $response
Definition hooks.txt:813
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:37
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.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$source
$property