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__);
41 * Creates an instance of this points class
43 * @param $userInstance An instance of a user class
44 * @return $pointsInstance An instance of this class
46 public final static function createUserPoints (ManageableAccount $userInstance) {
48 $pointsInstance = new UserPoints();
51 $pointsInstance->setUserInstance($userInstance);
53 // Get a critieria instance
54 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
56 // Add search criteria
57 $searchInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $userInstance->getUserId());
58 $searchInstance->setLimit(1);
60 // Get a wrapper instance
61 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
64 $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
66 // Set it in this instance
67 $pointsInstance->setResultInstance();
70 return $pointsInstance;
76 * @param $amount Amount of points to store
79 public final function setAmount ($amount) {
80 $this->amount = (float) $amount;
86 * @return $amount Amount of points to store
88 public final function getAmount () {
93 * Checks wether the user has the required amount of points left for the specified action
95 * @param $action The action or configuration entry plus prefix the user wants to perform
96 * @return $hasRequired Wether the user has the required points
97 * @todo Finish loading part of points
99 public function ifUserHasRequiredPoints ($action) {
100 // Default is that everyone is poor... ;-)
101 $hasRequired = false;
103 // Get the required points entry
104 $requiredPoints = $this->getConfigInstance()->getConfigEntry($action . '_action_points');
106 // Do we have an entry?
107 if ($this->getResultInstance()->next()) {
109 $currEntry = $this->getResultInstance()->current();
111 // Has he enought points?
112 $hasRequired = ($currEntry['points'] >= $requiredPoints);
120 * "Books" the given points amount on the current user's account
122 * @param $amount Amount of points we shall book
125 function bookPointsDirectly ($amount) {
126 // Do we have an entry?
127 if ($this->getResultInstance()->next()) {
129 $entry = $this->getResultInstance()->current();
132 $amount += $entry[UserPointsDatabaseWrapper::DB_COLUMN_POINTS];
134 // Now get another criteria
135 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
137 // And add our both entries
138 $updateInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $amount);
140 // Add the search criteria for searching for the right entry
141 $updateInstance->setSearchInstance($searchInstance);
143 // Set wrapper class name
144 $updateInstance->setWrapperConfigEntry('user_points_db_wrapper_class');
146 // Remember the update in database result
147 $this->getResultInstance()->add2UpdateQueue($updateInstance);
149 // Set the amount in class
150 $this->setAmount($amount);
152 // Create the new entry
153 $wrapperInstance->insertUserPoints($this);
158 * Adds registration elements to a given dataset instance
160 * @param $criteriaInstance An instance of a storeable criteria
163 public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
165 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
168 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $this->getAmount());