inc/main/interfaces/points/class_BookablePoints.php

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