framework/main/interfaces/user/class_ManageableAccount.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\User;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7 use Org\Mxchange\CoreFramework\Request\Requestable;
   8
   9 /**
  10  * An interface for manageable accounts (logged-in users and guests likewise)
  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 ManageableAccount extends FrameworkInterface {
  32         /**
  33          * Determines whether the username exists or not
  34          *
  35          * @return      $exists         Whether the username exists
  36          */
  37         function ifUsernameExists ();
  38
  39         /**
  40          * Determines whether the email exists or not
  41          *
  42          * @return      $exists         Whether the email exists
  43          */
  44         function ifEmailAddressExists ();
  45
  46         /**
  47          * Checks if supplied password hash in request matches with stored in
  48          * database.
  49          *
  50          * @param       $requestInstance        A Requestable class instance
  51          * @return      $matches                        Whether the supplied password hash matches
  52          */
  53         function ifPasswordHashMatches (Requestable $requestInstance);
  54
  55 }