3 * A class for handling user points which can be real or Internet currency
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class UserPoints extends BaseFrameworkSystem implements Registerable, BookablePoints {
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
40 $this->removeNumberFormaters();
41 $this->removeSystemArray();
45 * Creates an instance of this points class
47 * @param $userInstance An instance of a user class
48 * @return $pointsInstance An instance of this class
50 public final static function createUserPoints (ManageableAccount $userInstance) {
52 $pointsInstance = new UserPoints();
55 $pointsInstance->setUserInstance($userInstance);
58 return $pointsInstance;
64 * @param $amount Amount of points to store
67 public final function setAmount ($amount) {
68 $this->amount = (float) $amount;
74 * @return $amount Amount of points to store
76 public final function getAmount () {
81 * Checks wether the user has the required amount of points left for the specified action
83 * @param $action The action or configuration entry plus prefix the user wants to perform
84 * @return $hasRequired Wether the user has the required points
85 * @todo Finish loading part of points
87 public function ifUserHasRequiredPoints ($action) {
88 // Default is that everyone is poor... ;-)
91 // Get the required points entry
92 $requiredPoints = $this->getConfigInstance()->readConfig($action . '_action_points');
94 // Now get a search criteria and set the user's name as criteria
95 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
96 $searchInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
97 $searchInstance->setLimit(1);
99 // Get a wrapper instance
100 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
103 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
105 // Do we have an entry?
106 if ($resultInstance->next()) {
107 // @TODO Load points here
108 $this->partialStub("Load points here for comparison.");
116 * "Books" the given points amount on the current user's account
118 * @param $amount Amount of points we shall book
121 function bookPointsDirectly ($amount) {
122 // Get a critieria instance
123 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
125 // Add search criteria
126 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
127 $searchInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
128 $searchInstance->setLimit(1);
130 // Get a wrapper instance
131 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
134 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
136 // Do we have an entry?
137 if ($resultInstance->next()) {
139 $entry = $resultInstance->current();
142 $amount += $entry[UserPointsDatabaseWrapper::DB_COLUMN_POINTS];
144 // Now get another criteria
145 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
147 // And add our both entries
148 $updateInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $amount);
150 // Add the search criteria for searching for the right entry
151 $updateInstance->setSearchInstance($searchInstance);
153 // Set wrapper class name
154 $updateInstance->setWrapperConfigEntry('user_points_db_wrapper_class');
156 // Remember the update in database result
157 $resultInstance->add2UpdateQueue($updateInstance);
160 $this->setResultInstance($resultInstance);
162 // Set the amount in class
163 $this->setAmount($amount);
165 // Create the new entry
166 $wrapperInstance->insertUserPoints($this);
171 * Adds registration elements to a given dataset instance
173 * @param $criteriaInstance An instance of a storeable criteria
176 public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
178 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
181 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $this->getAmount());