seeddms-code/inc/inc.ClassAuthentication.php

<?php
/**
 * Implementation of user authentication
 *
 * @category  DMS
 * @package   SeedDMS
 * @author    Uwe Steinmann <uwe@steinmann.cx>
 * @copyright 2010-2016 Uwe Steinmann
 * @license   GPL 2
 * @version   @package_version@
 * @link      https://www.seeddms.org
 */

/**
 * Abstract class to authenticate user
 *
 * @category  DMS
 * @package   SeedDMS
 * @author    Uwe Steinmann <uwe@steinmann.cx>
 * @copyright 2010-2016 Uwe Steinmann
 * @license   GPL 2
 * @version   Release: @package_version@
 * @link      https://www.seeddms.org
 */
abstract class SeedDMS_Authentication
{
	/**
	 * DMS object
	 *
	 * @var    SeedDMS_Core_DMS
	 * @access protected
	 */
	protected $dms;

	/**
	 * DMS settings
	 *
	 * @var    Settings
	 * @access protected
	 */
	protected $settings;

	/**
	 * Constructor
	 *
	 * @param SeedDMS_Core_DMS $dms      DMS object
	 * @param Settings         $settings DMS settings
	 */
	function __construct($dms, $settings) /* {{{ */
	{
		$this->dms = $dms;
		$this->settings = $settings;
	} /* }}} */

	/**
	 * Do Authentication
	 *
	 * This function must check the username and login. If authentication succeeds
	 * the user object otherwise false must be returned. If authentication fails
	 * the number of failed logins should be incremented and account disabled.
	 *
	 * @param string $username name of user to authenticate
	 * @param string $password password of user to authenticate
	 *
	 * @return object|false user object if authentication was successful
	 * otherwise false
	 */
	abstract function authenticate($username, $password);
}