3 namespace Org\Mxchange\CoreFramework\Auth;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
7 use Org\Mxchange\CoreFramework\Request\Requestable;
8 use Org\Mxchange\CoreFramework\Response\Responseable;
11 * An interface for user login classes
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 <<<<<<< HEAD:framework/main/interfaces/login/class_LoginableUser.php
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
19 >>>>>>> Some updates::inc/main/interfaces/login/class_LoginableUser.php
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 interface LoginableUser extends FrameworkInterface {
38 * Logins the user with the given request containing the credential. The
39 * result of the login can be thrown by exception or, if prefered stored
40 * in a boolean attribute which is then readable by a matching getter.
42 * @param $requestInstance An instance of a Requestable class
43 * @param $responseInstance An instance of a Responseable class
46 function doLogin (Requestable $requestInstance, Responseable $responseInstance);
49 * Check if the implementation is correct. Only the request instance is
50 * needed as no redirect is done here.
52 * @param $requestInstance An instance of a Requestable class
55 function testLogin (Requestable $requestInstance);