inc/main/interfaces/login/class_LoginableUser.php

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