inc/classes/interfaces/user/class_ManageableUser.php

   1 <?php
   2 /**
   3  * An interface for manageable users
   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 ManageableUser extends FrameworkInterface {
  25         /**
  26          * Determines wether the username exists or not
  27          *
  28          * @return      $exists         Wether the username exists
  29          */
  30         function ifUsernameExists ();
  31
  32         /**
  33          * Determines wether the email exists or not
  34          *
  35          * @return      $exists         Wether the email exists
  36          */
  37         function ifEmailAddressExists ();
  38
  39         /**
  40          * Checks if the supplied password hash in request matches with the stored
  41          * in database.
  42          *
  43          * @param       $requestInstance        A requestable class instance
  44          * @return      $matches                        Wether the supplied password hash matches
  45          */
  46         function ifPasswordHashMatches (Requestable $requestInstance);
  47
  48         /**
  49          * Adds data for later complete update
  50          *
  51          * @param       $column         Column we want to update
  52          * @param       $value          New value to store in database
  53          * @return      void
  54          */
  55         function addUpdateData ($column, $value);
  56 }
  57
  58 //
  59 ?>