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