MediaWiki REL1_27
PrimaryAuthenticationProvider.php
Go to the documentation of this file.
1<?php
24namespace MediaWiki\Auth;
25
27use User;
28
54 const TYPE_CREATE = 'create';
56 const TYPE_LINK = 'link';
58 const TYPE_NONE = 'none';
59
66 public function getAuthenticationRequests( $action, array $options );
67
81 public function beginPrimaryAuthentication( array $reqs );
82
92 public function continuePrimaryAuthentication( array $reqs );
93
102
109 public function testUserExists( $username, $flags = User::READ_NORMAL );
110
117
139
152
160
175 AuthenticationRequest $req, $checkData = true
176 );
177
190
195 public function accountCreationType();
196
211 public function testForAccountCreation( $user, $creator, array $reqs );
212
230 public function beginPrimaryAccountCreation( $user, $creator, array $reqs );
231
246 public function continuePrimaryAccountCreation( $user, $creator, array $reqs );
247
264 public function finishAccountCreation( $user, $creator, AuthenticationResponse $response );
265
278 public function postAccountCreation( $user, $creator, AuthenticationResponse $response );
279
290 public function testUserForCreation( $user, $autocreate );
291
300 public function autoCreatedAccount( $user, $source );
301
317 public function beginPrimaryAccountLink( $user, array $reqs );
318
331 public function continuePrimaryAccountLink( $user, array $reqs );
332
341
342}
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:968
the array() calling protocol came about after MediaWiki 1.4rc1.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition hooks.txt:1042
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2555
this hook is for auditing only or null if authentication failed before getting that far $username
Definition hooks.txt:767
this hook is for auditing only $response
Definition hooks.txt:765
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 determines which user is trying to log in.
testUserForCreation( $user, $autocreate)
Determine whether an account may be created.
getAuthenticationRequests( $action, array $options)
{Return the applicable list of AuthenticationRequests.Possible values for $action depend on whether t...
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.
$source
$property