gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2024-11-26 15:32:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add documentation for authenticate()

Browse Source
This commit is contained in:
Uwe Steinmann 2023-08-25 12:33:08 +02:00
parent d602484f4b
commit 8ac054cb72
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
inc/inc.ClassAuthenticationService.php
View File

@ -63,6 +63,19 @@ class SeedDMS_AuthenticationService {
return $this->errors; return $this->errors;
} /* }}} */ } /* }}} */
/**
* Run each authentication service
*
* This method calls authenticate() of each authentication service and
* evaluates the returned value.
* If the authentication method returns false (some internal error which
* prevented to check authentication at all), this method will return
* false imediately, in case of null (no valid authentication) the next
* service will be tried and in all other cases the value will be returned.
*
* @param string $username name of user
* @param string $password password of user
*/
public function authenticate($username, $password) { /* {{{ */ public function authenticate($username, $password) { /* {{{ */
$user = null; $user = null;
foreach($this->services as $name => $service) { foreach($this->services as $name => $service) {