3 * A class for handling user points which can be real or Internet currency
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 static final 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 // Advance to first entry by default
67 $resultInstance->next();
69 // Set it in this instance
70 $pointsInstance->setResultInstance($resultInstance);
73 return $pointsInstance;
79 * @param $amount Amount of points to store
82 public final function setAmount ($amount) {
83 $this->amount = (float) $amount;
89 * @return $amount Amount of points to store
91 public final function getAmount () {
96 * Checks whether the user has the required amount of points left for the specified action
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
102 public function ifUserHasRequiredPoints ($action) {
103 // Default is that everyone is poor... ;-)
104 $hasRequired = FALSE;
106 // Get the required points entry
107 $requiredPoints = $this->getConfigInstance()->getConfigEntry($action . '_action_points');
110 $this->getResultInstance()->rewind();
112 // Do we have an entry?
113 if ($this->getResultInstance()->next()) {
115 $currEntry = $this->getResultInstance()->current();
117 // Has he enought points?
118 $hasRequired = ($currEntry['points'] >= $requiredPoints);
126 * "Books" the given points amount on the current user's account
128 * @param $amount Amount of points we shall book
131 function bookPointsDirectly ($amount) {
133 $this->getResultInstance()->rewind();
135 // Do we have an entry?
136 if ($this->getResultInstance()->next()) {
138 $entry = $this->getResultInstance()->current();
141 $amount += $entry[UserPointsDatabaseWrapper::DB_COLUMN_POINTS];
143 // Now get another criteria
144 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
146 // And add our both entries
147 $updateInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $amount);
149 // Add the search criteria for searching for the right entry
150 $updateInstance->setSearchInstance($searchInstance);
152 // Set wrapper class name
153 $updateInstance->setWrapperConfigEntry('user_points_db_wrapper_class');
155 // Remember the update in database result
156 $this->getResultInstance()->add2UpdateQueue($updateInstance);
158 // Set the amount in class
159 $this->setAmount($amount);
161 // Create the new entry
162 $wrapperInstance->insertUserPoints($this);
167 * Adds registration elements to a given dataset instance
169 * @param $criteriaInstance An instance of a StoreableCriteria class
170 * @param $requestInstance An instance of a Requestable class
173 public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) {
175 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS_UID, $this->getUserInstance()->getUserId());
178 $criteriaInstance->addCriteria(UserPointsDatabaseWrapper::DB_COLUMN_POINTS, $this->getAmount());