pdnsmanager/backend/plugins/UserAuth/InterfaceUserAuth.php
2018-03-21 17:30:24 +01:00

32 lines
815 B
PHP

<?php
namespace Plugins\UserAuth;
require '../vendor/autoload.php';
/**
* This interface provides the neccessary functions for
* a user authentication backend.
*/
interface InterfaceUserAuth
{
/**
* Construct the object
*
* @param $logger Monolog logger instance for error handling
* @param $db Database connection
* @param $config The configuration for the Plugin if any was provided
*/
public function __construct(\Monolog\Logger $logger, \PDO $db, array $config = null);
/**
* Authenticate user.
*
* @param $username The key for the entry
* @param $password The value for the entry
*
* @return true if valid false otherwise
*/
public function authenticate(string $username, string $password) : bool;
}