Page MenuHomeWickedGov Phorge
Files F581588

AbstractPrimaryAuthenticationProvider.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

AbstractPrimaryAuthenticationProvider.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Auth;
/**
* A base class that implements some of the boilerplate for a PrimaryAuthenticationProvider
*
* @stable to extend
* @ingroup Auth
* @since 1.27
*/
abstract class AbstractPrimaryAuthenticationProvider extends AbstractAuthenticationProvider
implements PrimaryAuthenticationProvider
{
/**
* @stable to override
*
* @param array $reqs
*
* @return AuthenticationResponse|void
*/
public function continuePrimaryAuthentication( array $reqs ) {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
}
/**
* @inheritDoc
* @stable to override
*/
public function postAuthentication( $user, AuthenticationResponse $response ) {
}
/**
* @inheritDoc
* @stable to override
*/
public function testUserCanAuthenticate( $username ) {
// Assume it can authenticate if it exists
return $this->testUserExists( $username );
}
/**
* @inheritDoc
* @stable to override
* @note Reimplement this if you do anything other than
* UserNameUtils->getCanonical( $req->username ) to determine the user being
* authenticated.
*/
public function providerNormalizeUsername( $username ) {
$name = $this->userNameUtils->getCanonical( $username );
return $name === false ? null : $name;
}
/**
* @inheritDoc
* @stable to override
* @note Reimplement this if self::getAuthenticationRequests( AuthManager::ACTION_REMOVE )
* doesn't return requests that will revoke all access for the user.
*/
public function providerRevokeAccessForUser( $username ) {
$reqs = $this->getAuthenticationRequests(
AuthManager::ACTION_REMOVE, [ 'username' => $username ]
);
foreach ( $reqs as $req ) {
$req->username = $username;
$req->action = AuthManager::ACTION_REMOVE;
$this->providerChangeAuthenticationData( $req );
}
}
/**
* @inheritDoc
* @stable to override
*/
public function providerAllowsPropertyChange( $property ) {
return true;
}
/**
* @inheritDoc
* @stable to override
*/
public function testForAccountCreation( $user, $creator, array $reqs ) {
return \StatusValue::newGood();
}
/**
* @inheritDoc
* @stable to override
*/
public function continuePrimaryAccountCreation( $user, $creator, array $reqs ) {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
}
/**
* @inheritDoc
* @stable to override
*/
public function finishAccountCreation( $user, $creator, AuthenticationResponse $response ) {
return null;
}
/**
* @inheritDoc
* @stable to override
*/
public function postAccountCreation( $user, $creator, AuthenticationResponse $response ) {
}
/**
* @inheritDoc
* @stable to override
*/
public function testUserForCreation( $user, $autocreate, array $options = [] ) {
return \StatusValue::newGood();
}
/**
* @inheritDoc
* @stable to override
*/
public function autoCreatedAccount( $user, $source ) {
}
/**
* @inheritDoc
* @stable to override
*/
public function beginPrimaryAccountLink( $user, array $reqs ) {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
if ( $this->accountCreationType() === self::TYPE_LINK ) {
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
} else {
throw new \BadMethodCallException(
__METHOD__ . ' should not be called on a non-link provider.'
);
}
}
/**
* @inheritDoc
* @stable to override
*/
public function continuePrimaryAccountLink( $user, array $reqs ) {
// @phan-suppress-previous-line PhanPluginNeverReturnMethod
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
}
/**
* @inheritDoc
* @stable to override
*/
public function postAccountLink( $user, AuthenticationResponse $response ) {
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Apr 1, 08:17 (1 d, 20 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
82/18/a09fe16698b6dcbcc83f2ff053a5
Default Alt Text
AbstractPrimaryAuthenticationProvider.php (3 KB)

Event Timeline