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, this is free software
   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 {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set part description
  35                 $this->setObjectDescription("Class for handling user points");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeNumberFormaters();
  42                 $this->removeSystemArray();
  43         }
  44
  45         /**
  46          * Creates an instance of this points class
  47          *
  48          * @param       $userInstance           An instance of a user class
  49          * @return      $pointsInstance         An instance of this class
  50          */
  51         public final static function createUserPoints (ManageableAccount $userInstance) {
  52                 // Get a new instance
  53                 $pointsInstance = new UserPoints();
  54
  55                 // Set user instance
  56                 $pointsInstance->setUserInstance($userInstance);
  57
  58                 // Return instance
  59                 return $pointsInstance;
  60         }
  61
  62         /**
  63          * Checks wether the user has the required amount of points left for the specified action
  64          *
  65          * @param       $action                 The action or configuration entry plus prefix the user wants to perform
  66          * @return      $hasRequired    Wether the user has the required points
  67          */
  68         public function ifUserHasRequiredPoints ($action) {
  69                 // Default is that everyone is poor... ;-)
  70                 $hasRequired = false;
  71
  72                 // Get the required points entry
  73                 $requiredPoints = $this->getConfigInstance()->readConfig($action . '_action_points');
  74
  75                 // Get a wrapper instance
  76                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
  77
  78                 // Now get a search criteria and set the user's name as criteria
  79                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  80                 $criteriaInstance->addCriteria('points_uid', $this->getUserInstance()->getUserName());
  81                 $criteriaInstance->setLimit(1);
  82
  83                 // Get result back
  84                 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
  85
  86                 // Do we have an entry?
  87                 if ($resultInstance->next()) {
  88                         // Load points here - TODO!
  89                         $this->partialStub("Load points here for comparison.");
  90                 } // END - if
  91
  92                 // Return the result
  93                 return $hasRequired;
  94         }
  95 }
  96
  97 // [EOF]
  98 ?>