]> git.mxchange.org Git - core.git/blob - framework/main/interfaces/user/class_ManageableAccount.php
Some updates:
[core.git] / 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 <<<<<<< HEAD:framework/main/interfaces/user/class_ManageableAccount.php
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 =======
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
18 >>>>>>> Some updates::inc/main/interfaces/user/class_ManageableAccount.php
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.shipsimu.org
21  *
22  * This program is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License as published by
24  * the Free Software Foundation, either version 3 of the License, or
25  * (at your option) any later version.
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  * GNU General Public License for more details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
34  */
35 interface ManageableAccount extends FrameworkInterface {
36         /**
37          * Determines whether the username exists or not
38          *
39          * @return      $exists         Whether the username exists
40          */
41         function ifUsernameExists ();
42
43         /**
44          * Determines whether the email exists or not
45          *
46          * @return      $exists         Whether the email exists
47          */
48         function ifEmailAddressExists ();
49
50         /**
51          * Checks if supplied password hash in request matches with stored in
52          * database.
53          *
54          * @param       $requestInstance        A Requestable class instance
55          * @return      $matches                        Whether the supplied password hash matches
56          */
57         function ifPasswordHashMatches (Requestable $requestInstance);
58
59 }