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