diff options
| author | Joseph Warner <hardolaf@hardolaf.com> | 2013-06-18 15:17:14 -0400 |
|---|---|---|
| committer | Joseph Warner <hardolaf@hardolaf.com> | 2013-06-18 15:20:41 -0400 |
| commit | e64abea999f68b248cfe41ab22ac60abc9e2951f (patch) | |
| tree | ac40a6e5438ed2b9431f9ac45aec76b44a753d2e /phpBB/includes | |
| parent | 817813034032b8e94079f195db097f2377ae9ac3 (diff) | |
| download | forums-e64abea999f68b248cfe41ab22ac60abc9e2951f.tar forums-e64abea999f68b248cfe41ab22ac60abc9e2951f.tar.gz forums-e64abea999f68b248cfe41ab22ac60abc9e2951f.tar.bz2 forums-e64abea999f68b248cfe41ab22ac60abc9e2951f.tar.xz forums-e64abea999f68b248cfe41ab22ac60abc9e2951f.zip | |
[feature/auth-refactor] Document the provider interface
Provides basic documentation of the auth_provideR_interface.
Changes the login method to login($username, $password) for
consistency with the providers.
acp() is not fully documented. It appears that it is meant to
return an array of some sort and take in a variable by reference.
PHPBB3-9734
Diffstat (limited to 'phpBB/includes')
| -rw-r--r-- | phpBB/includes/auth/provider_interface.php | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/phpBB/includes/auth/provider_interface.php b/phpBB/includes/auth/provider_interface.php index ac7bb311a3..8d966d8b3e 100644 --- a/phpBB/includes/auth/provider_interface.php +++ b/phpBB/includes/auth/provider_interface.php @@ -22,11 +22,41 @@ if (!defined('IN_PHPBB')) */ class 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(); - public function login(); + /** + * 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(); } |