Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / framework / main / interfaces / points / class_BookablePoints.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\User\Points;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Criteria\Add\AddableCriteria;
7
8 /**
9  * An interface for bookable points
10  *
11  * @author              Roland Haeder <webmaster@shipsimu.org>
12  * @version             0.0.0
13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14  * @license             GNU GPL 3.0 or any newer version
15  * @link                http://www.shipsimu.org
16  *
17  * This program is free software: you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation, either version 3 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
29  */
30 interface BookablePoints extends AddableCriteria {
31         /**
32          * Checks whether the user has the required amount of points left for the specified action
33          *
34          * @param       $action                 The action or configuration entry plus prefix the user wants to perform
35          * @return      $hasRequired    Whether the user has the required points
36          */
37         function ifUserHasRequiredPoints ($action);
38
39         /**
40          * "Books" the given points amount on the current user's account
41          *
42          * @param       $amount         Amount of points we shall book
43          * @return      void
44          */
45         function bookPointsDirectly ($amount);
46
47 }