MediaWiki REL1_32
AbstractPrimaryAuthenticationProvider.php
Go to the documentation of this file.
1<?php
22namespace MediaWiki\Auth;
23
24use User;
25
34{
35
36 public function continuePrimaryAuthentication( array $reqs ) {
37 throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
38 }
39
41 }
42
44 // Assume it can authenticate if it exists
45 return $this->testUserExists( $username );
46 }
47
56 return $name === false ? null : $name;
57 }
58
65 $reqs = $this->getAuthenticationRequests(
66 AuthManager::ACTION_REMOVE, [ 'username' => $username ]
67 );
68 foreach ( $reqs as $req ) {
69 $req->username = $username;
72 }
73 }
74
76 return true;
77 }
78
79 public function testForAccountCreation( $user, $creator, array $reqs ) {
80 return \StatusValue::newGood();
81 }
82
83 public function continuePrimaryAccountCreation( $user, $creator, array $reqs ) {
84 throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
85 }
86
87 public function finishAccountCreation( $user, $creator, AuthenticationResponse $response ) {
88 return null;
89 }
90
91 public function postAccountCreation( $user, $creator, AuthenticationResponse $response ) {
92 }
93
94 public function testUserForCreation( $user, $autocreate, array $options = [] ) {
95 return \StatusValue::newGood();
96 }
97
98 public function autoCreatedAccount( $user, $source ) {
99 }
100
101 public function beginPrimaryAccountLink( $user, array $reqs ) {
102 if ( $this->accountCreationType() === self::TYPE_LINK ) {
103 throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
104 } else {
105 throw new \BadMethodCallException(
106 __METHOD__ . ' should not be called on a non-link provider.'
107 );
108 }
109 }
110
111 public function continuePrimaryAccountLink( $user, array $reqs ) {
112 throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
113 }
114
116 }
117
118}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
A base class that implements some of the boilerplate for an AuthenticationProvider.
A base class that implements some of the boilerplate for a PrimaryAuthenticationProvider.
continuePrimaryAuthentication(array $reqs)
Continue an authentication flow.
beginPrimaryAccountLink( $user, array $reqs)
Start linking an account to an existing user.
postAuthentication( $user, AuthenticationResponse $response)
Post-login callback.
testUserCanAuthenticate( $username)
Test whether the named user can authenticate with this provider.
continuePrimaryAccountCreation( $user, $creator, array $reqs)
Continue an account creation flow.
testUserForCreation( $user, $autocreate, array $options=[])
Determine whether an account may be created.
providerAllowsPropertyChange( $property)
Determine whether a property can change.
postAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
continuePrimaryAccountLink( $user, array $reqs)
Continue linking an account to an existing user.
finishAccountCreation( $user, $creator, AuthenticationResponse $response)
Post-creation callback.
postAccountLink( $user, AuthenticationResponse $response)
Post-link callback.
testForAccountCreation( $user, $creator, array $reqs)
Determine whether an account creation may begin.
const ACTION_REMOVE
Remove a user's credentials.
This is a value object to hold authentication response data.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid.
Definition User.php:1238
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
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
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
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
A primary authentication provider is responsible for associating the submitted authentication data wi...
getAuthenticationRequests( $action, array $options)
@inheritDoc
providerChangeAuthenticationData(AuthenticationRequest $req)
Change or remove authentication data (e.g.
testUserExists( $username, $flags=User::READ_NORMAL)
Test whether the named user exists.
accountCreationType()
Fetch the account-creation type.
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