]> git.mxchange.org Git - shipsimu.git/blob - inc/classes/main/points/class_UserPoints.php
Web link helper basicly finished
[shipsimu.git] / 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                 // Clean up a little
35                 $this->removeNumberFormaters();
36                 $this->removeSystemArray();
37         }
38
39         /**
40          * Creates an instance of this points class
41          *
42          * @param       $userInstance           An instance of a user class
43          * @return      $pointsInstance         An instance of this class
44          */
45         public final static function createUserPoints (ManageableAccount $userInstance) {
46                 // Get a new instance
47                 $pointsInstance = new UserPoints();
48
49                 // Set user instance
50                 $pointsInstance->setUserInstance($userInstance);
51
52                 // Return instance
53                 return $pointsInstance;
54         }
55
56         /**
57          * Checks wether the user has the required amount of points left for the specified action
58          *
59          * @param       $action                 The action or configuration entry plus prefix the user wants to perform
60          * @return      $hasRequired    Wether the user has the required points
61          */
62         public function ifUserHasRequiredPoints ($action) {
63                 // Default is that everyone is poor... ;-)
64                 $hasRequired = false;
65
66                 // Get the required points entry
67                 $requiredPoints = $this->getConfigInstance()->readConfig($action . '_action_points');
68
69                 // Get a wrapper instance
70                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_points_db_wrapper_class');
71
72                 // Now get a search criteria and set the user's name as criteria
73                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
74                 $criteriaInstance->addCriteria('points_uid', $this->getUserInstance()->getUserName());
75                 $criteriaInstance->setLimit(1);
76
77                 // Get result back
78                 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
79
80                 // Do we have an entry?
81                 if ($resultInstance->next()) {
82                         // Load points here - TODO!
83                         $this->partialStub("Load points here for comparison.");
84                 } // END - if
85
86                 // Return the result
87                 return $hasRequired;
88         }
89 }
90
91 // [EOF]
92 ?>