gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2025-05-30 05:27:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

many code style cleanups

Browse Source
This commit is contained in:
Uwe Steinmann 2021-09-20 16:41:48 +02:00
parent 822a07485c
commit 63ae861257
1 changed files with 37 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
inc/inc.ClassAuthentication.php
View File

@ -2,38 +2,52 @@
/** /**
* Implementation of user authentication * Implementation of user authentication
* *
* @category DMS * @category DMS
* @package SeedDMS * @package SeedDMS
* @license GPL 2 * @author Uwe Steinmann <uwe@steinmann.cx>
* @version @version@ * @copyright 2010-2016 Uwe Steinmann
* @author Uwe Steinmann <uwe@steinmann.cx> * @license GPL 2
* @copyright Copyright (C) 2010-2016 Uwe Steinmann * @version @package_version@
* @version Release: @package_version@ * @link https://www.seeddms.org
*/ */
/** /**
* Abstract class to authenticate user * Abstract class to authenticate user
* *
* @category DMS * @category DMS
* @package SeedDMS * @package SeedDMS
* @author Uwe Steinmann <uwe@steinmann.cx> * @author Uwe Steinmann <uwe@steinmann.cx>
* @copyright Copyright (C) 2010-2016 Uwe Steinmann * @copyright 2010-2016 Uwe Steinmann
* @version Release: @package_version@ * @license GPL 2
* @version Release: @package_version@
* @link https://www.seeddms.org
*/ */
abstract class SeedDMS_Authentication { abstract class SeedDMS_Authentication
{
/** /**
* @var object $dms object of dms * DMS object
*
* @var SeedDMS_Core_DMS
* @access protected * @access protected
*/ */
private $dms; protected $dms;
/** /**
* @var object $settings SeedDMS Settings * DMS settings
*
* @var Settings
* @access protected * @access protected
*/ */
private $settings; protected $settings;
function __construct($dms, $settings) { /* {{{ */ /**
* Constructor
*
* @param SeedDMS_Core_DMS $dms DMS object
* @param Settings $settings DMS settings
*/
function __construct($dms, $settings) /* {{{ */
{
$this->dms = $dms; $this->dms = $dms;
$this->settings = $settings; $this->settings = $settings;
} /* }}} */ } /* }}} */
@ -45,9 +59,11 @@ abstract class SeedDMS_Authentication {
* the user object otherwise false must be returned. If authentication fails * the user object otherwise false must be returned. If authentication fails
* the number of failed logins should be incremented and account disabled. * the number of failed logins should be incremented and account disabled.
* *
* @param string $username * @param string $username name of user to authenticate
* @param string $password * @param string $password password of user to authenticate
* @return object|boolean user object if authentication was successful otherwise false *
* @return object|false user object if authentication was successful
* otherwise false
*/ */
abstract function authenticate($username, $password); abstract function authenticate($username, $password);
} }