MediaWiki  master
Go to the documentation of this file.
1 <?php
24 namespace MediaWiki\Auth;
27 use User;
77  const TYPE_CREATE = 'create';
79  const TYPE_LINK = 'link';
81  const TYPE_NONE = 'none';
89  public function getAuthenticationRequests( $action, array $options );
104  public function beginPrimaryAuthentication( array $reqs );
115  public function continuePrimaryAuthentication( array $reqs );
141  public function testUserExists( $username, $flags = User::READ_NORMAL );
152  public function testUserCanAuthenticate( $username );
174  public function providerNormalizeUsername( $username );
187  public function providerRevokeAccessForUser( $username );
195  public function providerAllowsPropertyChange( $property );
211  AuthenticationRequest $req, $checkData = true
212  );
235  public function accountCreationType();
251  public function testForAccountCreation( $user, $creator, array $reqs );
270  public function beginPrimaryAccountCreation( $user, $creator, array $reqs );
286  public function continuePrimaryAccountCreation( $user, $creator, array $reqs );
305  public function finishAccountCreation( $user, $creator, AuthenticationResponse $response );
323  public function postAccountCreation( $user, $creator, AuthenticationResponse $response );
343  public function testUserForCreation( $user, $autocreate, array $options = [] );
353  public function autoCreatedAccount( $user, $source );
370  public function beginPrimaryAccountLink( $user, array $reqs );
384  public function continuePrimaryAccountLink( $user, array $reqs );
400 }
beginPrimaryAccountLink( $user, array $reqs)
Start linking an account to an existing user.
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
An AuthenticationProvider is used by AuthManager when authenticating users.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
beginPrimaryAuthentication(array $reqs)
Start an authentication flow.
getAuthenticationRequests( $action, array $options)
postAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
string $action
Cache what action this request is.
Definition: MediaWiki.php:48
This is a value object to hold authentication response data.
this hook is for auditing only $response
Definition: hooks.txt:767
A primary authentication provider is responsible for associating the submitted authentication data wi...
continuePrimaryAccountCreation( $user, $creator, array $reqs)
Continue an account creation flow.
postAuthentication( $user, AuthenticationResponse $response)
Post-login callback.
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
Provider can link to existing accounts elsewhere.
beginPrimaryAccountCreation( $user, $creator, array $reqs)
Start an account creation flow.
continuePrimaryAccountLink( $user, array $reqs)
Continue linking an account to an existing user.
providerNormalizeUsername( $username)
Normalize the username for authentication.
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:1972
finishAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
Provider cannot create or link to accounts.
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:35
this hook is for auditing only $req
Definition: hooks.txt:960
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:767
providerAllowsPropertyChange( $property)
Determine whether a property can change.
autoCreatedAccount( $user, $source)
Post-auto-creation callback.
Fetch the account-creation type.
providerAllowsAuthenticationDataChange(AuthenticationRequest $req, $checkData=true)
Validate a change of authentication data (e.g.
providerRevokeAccessForUser( $username)
Revoke the user&#39;s credentials.
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
continuePrimaryAuthentication(array $reqs)
Continue an authentication flow.
postAccountLink( $user, AuthenticationResponse $response)
Post-link callback.
testUserExists( $username, $flags=User::READ_NORMAL)
Test whether the named user exists.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
This is a value object for authentication requests.
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.