1fc8d79ac6
For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
104 lines
3.6 KiB
PHP
104 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* Authentication provider interface
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Auth
|
|
*/
|
|
|
|
namespace MediaWiki\Auth;
|
|
|
|
use Config;
|
|
use MediaWiki\HookContainer\HookContainer;
|
|
use Psr\Log\LoggerAwareInterface;
|
|
|
|
/**
|
|
* An AuthenticationProvider is used by AuthManager when authenticating users.
|
|
*
|
|
* This interface should not be implemented directly; use one of its children.
|
|
*
|
|
* Authentication providers can be registered via $wgAuthManagerAutoConfig.
|
|
*
|
|
* @ingroup Auth
|
|
* @since 1.27
|
|
*/
|
|
interface AuthenticationProvider extends LoggerAwareInterface {
|
|
|
|
/**
|
|
* Set AuthManager
|
|
* @param AuthManager $manager
|
|
*/
|
|
public function setManager( AuthManager $manager );
|
|
|
|
/**
|
|
* Set configuration
|
|
* @param Config $config
|
|
*/
|
|
public function setConfig( Config $config );
|
|
|
|
/**
|
|
* @param HookContainer $hookContainer
|
|
*/
|
|
public function setHookContainer( HookContainer $hookContainer );
|
|
|
|
/**
|
|
* Return a unique identifier for this instance
|
|
*
|
|
* This must be the same across requests. If multiple instances return the
|
|
* same ID, exceptions will be thrown from AuthManager.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUniqueId();
|
|
|
|
/**
|
|
* Return the applicable list of AuthenticationRequests
|
|
*
|
|
* Possible values for $action depend on whether the implementing class is
|
|
* also a PreAuthenticationProvider, PrimaryAuthenticationProvider, or
|
|
* SecondaryAuthenticationProvider.
|
|
* - ACTION_LOGIN: Valid for passing to beginAuthentication. Called on all
|
|
* providers.
|
|
* - ACTION_CREATE: Valid for passing to beginAccountCreation. Called on
|
|
* all providers.
|
|
* - ACTION_LINK: Valid for passing to beginAccountLink. Called on linking
|
|
* primary providers only.
|
|
* - ACTION_CHANGE: Valid for passing to AuthManager::changeAuthenticationData
|
|
* to change credentials. Called on primary and secondary providers.
|
|
* - ACTION_REMOVE: Valid for passing to AuthManager::changeAuthenticationData
|
|
* to remove credentials. Must work without additional user input (i.e.
|
|
* without calling loadFromSubmission). Called on primary and secondary
|
|
* providers.
|
|
*
|
|
* @see AuthManager::getAuthenticationRequests()
|
|
* @param string $action
|
|
* @param array $options Options are:
|
|
* - username: User name related to the action, or null/unset if anon.
|
|
* - ACTION_LOGIN: The currently logged-in user, if any.
|
|
* - ACTION_CREATE: The account creator, if non-anonymous.
|
|
* - ACTION_LINK: The local user being linked to.
|
|
* - ACTION_CHANGE: The user having data changed.
|
|
* - ACTION_REMOVE: The user having data removed.
|
|
* If you leave the username property of the returned requests empty, this
|
|
* will automatically be copied there (except for ACTION_CREATE where it
|
|
* wouldn't really make sense).
|
|
* @return AuthenticationRequest[]
|
|
*/
|
|
public function getAuthenticationRequests( $action, array $options );
|
|
|
|
}
|