1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-05-20 14:29:48 +02:00
php-phpbb/phpBB/includes/auth/provider_interface.php
Joseph Warner 2445766b92 [feature/auth-refactor] Refactor acp_board for new auth interface
Partially refactors acp_board for the new authentication interface.
Leaves some questionable if statements in the file.
Modifies the interface to correctly impletment the acp() method.
Modifies each provider to comply with the above mentioned interface
modification.

PHPBB3-9734
2013-06-19 15:02:34 -04:00

63 lines
1.4 KiB
PHP

<?php
/**
*
* @package auth
* @copyright (c) 2013 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/
/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
exit;
}
/**
* The interface authentication provider classes have to implement.
*
* @package auth
*/
interface phpbb_auth_provider_interface
{
/**
* Checks whether the user is currently identified to the authentication
* provider.
* Called in acp_board while setting authentication plugins.
*
* @return boolean|string False if the user is identified, otherwise an
* error message.
*/
public function init();
/**
* Performs login.
*
* @param $username string The name of the user being authenticated.
* @param $password string The password of the user.
* @return array An associative array of the format:
* array(
* 'status' => status constant
* 'error_msg' => string
* 'user_row' => array
* )
*/
public function login($username, $password);
/**
* Autologin function
*
* @return array containing the user row or empty if no auto login should
* take place
*/
public function autologin();
/**
* This function is used to output any required fields in the authentication
* admin panel. It also defines any required configuration table fields.
*/
public function acp($new);
}