Added optional $requestInstance parameter

[core.git] / inc / classes / main / points / class_UserPoints.php

diff --git a/inc/classes/main/points/class_UserPoints.php b/inc/classes/main/points/class_UserPoints.php
index 1dd62ec81b89a4acbe4398c953239221b162de20..13b210eba54818d47fc5e6be4070f55ed785aaae 100644 (file)
--- a/inc/classes/main/points/class_UserPoints.php
+++ b/inc/classes/main/points/class_UserPoints.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -35,10 +35,6 @@ class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePo
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Clean up a little
-               $this->removeNumberFormaters();
-               $this->removeSystemArray();
        }
 
        /**
@@ -47,13 +43,32 @@ class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePo
         * @param       $userInstance           An instance of a user class
         * @return      $pointsInstance         An instance of this class
         */
-       public final static function createUserPoints (ManageableAccount $userInstance) {
+       public static final function createUserPoints (ManageableAccount $userInstance) {
                // Get a new instance
                $pointsInstance = new UserPoints();
 
                // Set user instance
                $pointsInstance->setUserInstance($userInstance);
 
+               // Get a critieria instance
+               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
+
+               // Add search criteria
+               $searchInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $userInstance->getUserId());
+               $searchInstance->setLimit(1);
+
+               // Get a wrapper instance
+               $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
+
+               // Get result back
+               $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
+
+               // Advance to first entry by default
+               $resultInstance->next();
+
+               // Set it in this instance
+               $pointsInstance->setResultInstance($resultInstance);
+
                // Return instance
                return $pointsInstance;
        }
@@ -78,10 +93,10 @@ class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePo
        }
 
        /**
-        * Checks wether the user has the required amount of points left for the specified action
+        * Checks whether the user has the required amount of points left for the specified action
         *
         * @param       $action                 The action or configuration entry plus prefix the user wants to perform
-        * @return      $hasRequired    Wether the user has the required points
+        * @return      $hasRequired    Whether the user has the required points
         * @todo        Finish loading part of points
         */
        public function ifUserHasRequiredPoints ($action) {
@@ -89,23 +104,18 @@ class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePo
                $hasRequired = false;
 
                // Get the required points entry
-               $requiredPoints = $this->getConfigInstance()->readConfig($action . '_action_points');
-
-               // Now get a search criteria and set the user's name as criteria
-               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
-               $searchInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
-               $searchInstance->setLimit(1);
-
-               // Get a wrapper instance
-               $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
+               $requiredPoints = $this->getConfigInstance()->getConfigEntry($action . '_action_points');
 
-               // Get result back
-               $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
+               // Rewind always
+               $this->getResultInstance()->rewind();
 
                // Do we have an entry?
-               if ($resultInstance->next()) {
-                       // @TODO Load points here
-                       $this->partialStub("Load points here for comparison.");
+               if ($this->getResultInstance()->next()) {
+                       // Get the entry
+                       $currEntry = $this->getResultInstance()->current();
+
+                       // Has he enought points?
+                       $hasRequired = ($currEntry['points'] >= $requiredPoints);
                } // END - if
 
                // Return the result
@@ -119,24 +129,13 @@ class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePo
         * @return      void
         */
        function bookPointsDirectly ($amount) {
-               // Get a critieria instance
-               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
-
-               // Add search criteria
-               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
-               $searchInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
-               $searchInstance->setLimit(1);
-
-               // Get a wrapper instance
-               $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
-
-               // Get result back
-               $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
+               // Rewind always
+               $this->getResultInstance()->rewind();
 
                // Do we have an entry?
-               if ($resultInstance->next()) {
+               if ($this->getResultInstance()->next()) {
                        // Get the entry
-                       $entry = $resultInstance->current();
+                       $entry = $this->getResultInstance()->current();
 
                        // Add the points
                        $amount += $entry[UserPointsDatabaseWrapper::DB_COLUMN_POINTS];
@@ -154,10 +153,7 @@ class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePo
                        $updateInstance->setWrapperConfigEntry('user_points_db_wrapper_class');
 
                        // Remember the update in database result
-                       $resultInstance->add2UpdateQueue($updateInstance);
-
-                       // Set it
-                       $this->setResultInstance($resultInstance);
+                       $this->getResultInstance()->add2UpdateQueue($updateInstance);
                } else {
                        // Set the amount in class
                        $this->setAmount($amount);
@@ -170,10 +166,11 @@ class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePo
        /**
         * Adds registration elements to a given dataset instance
         *
-        * @param       $criteriaInstance       An instance of a storeable criteria
+        * @param       $criteriaInstance       An instance of a StoreableCriteria class
+        * @param       $requestInstance        An instance of a Requestable class
         * @return      void
         */
-       public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
+       public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) {
                // Add user id
                $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());