inc/classes/main/points/class_UserPoints.php

   1 <?php
   2 /**
   3  * A class for handling user points which can be real or Internet currency
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   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 class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePoints {
  25         /**
  26          * Amount of points
  27          */
  28         private $amount = 0;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38         }
  39
  40         /**
  41          * Creates an instance of this points class
  42          *
  43          * @param       $userInstance           An instance of a user class
  44          * @return      $pointsInstance         An instance of this class
  45          */
  46         public static final function createUserPoints (ManageableAccount $userInstance) {
  47                 // Get a new instance
  48                 $pointsInstance = new UserPoints();
  49
  50                 // Set user instance
  51                 $pointsInstance->setUserInstance($userInstance);
  52
  53                 // Get a critieria instance
  54                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  55
  56                 // Add search criteria
  57                 $searchInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $userInstance->getUserId());
  58                 $searchInstance->setLimit(1);
  59
  60                 // Get a wrapper instance
  61                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
  62
  63                 // Get result back
  64                 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
  65
  66                 // Advance to first entry by default
  67                 $resultInstance->next();
  68
  69                 // Set it in this instance
  70                 $pointsInstance->setResultInstance($resultInstance);
  71
  72                 // Return instance
  73                 return $pointsInstance;
  74         }
  75
  76         /**
  77          * Setter for amount
  78          *
  79          * @param       $amount         Amount of points to store
  80          * @return      void
  81          */
  82         public final function setAmount ($amount) {
  83                 $this->amount = (float) $amount;
  84         }
  85
  86         /**
  87          * Getter for amount
  88          *
  89          * @return      $amount         Amount of points to store
  90          */
  91         public final function getAmount () {
  92                 return $this->amount;
  93         }
  94
  95         /**
  96          * Checks whether the user has the required amount of points left for the specified action
  97          *
  98          * @param       $action                 The action or configuration entry plus prefix the user wants to perform
  99          * @return      $hasRequired    Whether the user has the required points
 100          * @todo        Finish loading part of points
 101          */
 102         public function ifUserHasRequiredPoints ($action) {
 103                 // Default is that everyone is poor... ;-)
 104                 $hasRequired = false;
 105
 106                 // Get the required points entry
 107                 $requiredPoints = $this->getConfigInstance()->getConfigEntry($action . '_action_points');
 108
 109                 // Rewind always
 110                 $this->getResultInstance()->rewind();
 111
 112                 // Do we have an entry?
 113                 if ($this->getResultInstance()->next()) {
 114                         // Get the entry
 115                         $currEntry = $this->getResultInstance()->current();
 116
 117                         // Has he enought points?
 118                         $hasRequired = ($currEntry['points'] >= $requiredPoints);
 119                 } // END - if
 120
 121                 // Return the result
 122                 return $hasRequired;
 123         }
 124
 125         /**
 126          * "Books" the given points amount on the current user's account
 127          *
 128          * @param       $amount         Amount of points we shall book
 129          * @return      void
 130          */
 131         function bookPointsDirectly ($amount) {
 132                 // Rewind always
 133                 $this->getResultInstance()->rewind();
 134
 135                 // Do we have an entry?
 136                 if ($this->getResultInstance()->next()) {
 137                         // Get the entry
 138                         $entry = $this->getResultInstance()->current();
 139
 140                         // Add the points
 141                         $amount += $entry[UserPointsDatabaseWrapper::DB_COLUMN_POINTS];
 142
 143                         // Now get another criteria
 144                         $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
 145
 146                         // And add our both entries
 147                         $updateInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $amount);
 148
 149                         // Add the search criteria for searching for the right entry
 150                         $updateInstance->setSearchInstance($searchInstance);
 151
 152                         // Set wrapper class name
 153                         $updateInstance->setWrapperConfigEntry('user_points_db_wrapper_class');
 154
 155                         // Remember the update in database result
 156                         $this->getResultInstance()->add2UpdateQueue($updateInstance);
 157                 } else {
 158                         // Set the amount in class
 159                         $this->setAmount($amount);
 160
 161                         // Create the new entry
 162                         $wrapperInstance->insertUserPoints($this);
 163                 }
 164         }
 165
 166         /**
 167          * Adds registration elements to a given dataset instance
 168          *
 169          * @param       $criteriaInstance       An instance of a storeable criteria
 170          * @return      void
 171          */
 172         public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
 173                 // Add user id
 174                 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
 175
 176                 // Add amount
 177                 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $this->getAmount());
 178         }
 179 }
 180
 181 // [EOF]
 182 ?>