diff options
author | Andrew Dolgov <[email protected]> | 2021-11-14 20:26:05 +0300 |
---|---|---|
committer | Andrew Dolgov <[email protected]> | 2021-11-14 20:26:05 +0300 |
commit | afdb4b00729c8589e99e4ba27981450d1433d9b2 (patch) | |
tree | f1ab6aadd95ff9c56d5d1baca4a4065c6d677ace /classes | |
parent | 6bd6a14c207ddaf35256b11dd381093d57ef38a4 (diff) |
set phpdoc annotations for auth_base
Diffstat (limited to 'classes')
-rw-r--r-- | classes/auth/base.php | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/classes/auth/base.php b/classes/auth/base.php index 9950cbf07..d8128400d 100644 --- a/classes/auth/base.php +++ b/classes/auth/base.php @@ -12,8 +12,14 @@ abstract class Auth_Base extends Plugin implements IAuthModule { return $this->authenticate($login, $password, $service); } - // Auto-creates specified user if allowed by system configuration - // Can be used instead of find_user_by_login() by external auth modules + /** Auto-creates specified user if allowed by system configuration. + * Can be used instead of find_user_by_login() by external auth modules + * @param string $login + * @param string|false $password + * @return null|int + * @throws Exception + * @throws PDOException + */ function auto_create_user(string $login, $password = false) { if ($login && Config::get(Config::AUTH_AUTO_CREATE)) { $user_id = UserHelper::find_user_by_login($login); @@ -41,7 +47,12 @@ abstract class Auth_Base extends Plugin implements IAuthModule { return UserHelper::find_user_by_login($login); } - // @deprecated + + /** replaced with UserHelper::find_user_by_login() + * @param string $login + * @return null|int + * @deprecated + */ function find_user_by_login(string $login) { return UserHelper::find_user_by_login($login); } |