Updated domain without a dash :(
[core.git] / inc / classes / interfaces / helper / login / class_HelpableLogin.php
1 <?php
2 /**
3  * A helper interface for logins
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 interface HelpableLogin extends Helper {
25         /**
26          * Execute the login request by given response instance. This instance can
27          * be used for sending cookies or at least the session id out.
28          *
29          * @param       $responseInstance       An instance of a Responseable class
30          * @return      void
31          */
32         function executeLogin (Responseable $responseInstance);
33 }
34
35 // [EOF]
36 ?>