inc/classes/interfaces/login/class_LoginableUser.php

   1 <?php
   2 /**
   3  * An interface for user login classes
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 LoginableUser extends FrameworkInterface {
  25         /**
  26          * Logins the user with the given request containing the credential. The
  27          * result of the login can be thrown by exception or, if prefered stored
  28          * in a boolean attribute which is then readable by a matching getter.
  29          *
  30          * @param       $requestInstance        An instance of a Requestable class
  31          * @param       $responseInstance       An instance of a Responseable class
  32          * @return      void
  33          */
  34         function doLogin (Requestable $requestInstance, Responseable $responseInstance);
  35 }
  36
  37 //
  38 ?>