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 <<<<<<< HEAD:framework/main/interfaces/points/class_BookablePoints.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/interfaces/points/class_BookablePoints.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 interface BookablePoints extends AddableCriteria {
  35         /**
  36          * Checks whether the user has the required amount of points left for the specified action
  37          *
  38          * @param       $action                 The action or configuration entry plus prefix the user wants to perform
  39          * @return      $hasRequired    Whether the user has the required points
  40          */
  41         function ifUserHasRequiredPoints ($action);
  42
  43         /**
  44          * "Books" the given points amount on the current user's account
  45          *
  46          * @param       $amount         Amount of points we shall book
  47          * @return      void
  48          */
  49         function bookPointsDirectly ($amount);
  50
  51 }