3e38be477996c8428cf6331b3b4aa5e962fd9821
[core.git] / inc / classes / main / filter / update / class_UserStatusConfimedUpdateFilter.php
1 <?php
2 /**
3  * A filter for updating the user account status to confirmed
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007 - 2009 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 UserStatusConfimedUpdateFilter extends BaseFilter implements Filterable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this filter class
37          *
38          * @return      $filterInstance                 An instance of this filter class
39          */
40         public final static function createUserStatusConfimedUpdateFilter () {
41                 // Get a new instance
42                 $filterInstance = new UserStatusConfimedUpdateFilter();
43
44                 // Return the instance
45                 return $filterInstance;
46         }
47
48         /**
49          * Executes the filter with given request and response objects
50          *
51          * @param       $requestInstance        An instance of a class with an Requestable interface
52          * @param       $responseInstance       An instance of a class with an Responseable interface
53          * @return      void
54          */
55         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
56                 // Get user instance from registry
57                 $userInstance = Registry::getRegistry()->getInstance('user');
58
59                 // Get "confirmed" status from config
60                 $confirmed = $this->getConfigInstance()->readConfig('user_status_confirmed');
61
62                 // Update the user status to "confirmed" here
63                 $userInstance->updateDatabaseField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS, $confirmed);
64
65                 // Wipe out the confirm hash for extra security
66                 $userInstance->updateDatabaseField(UserDatabaseWrapper::DB_COLUMN_CONFIRM_HASH, "");
67
68                 // Write all updates to the database
69                 $userInstance->flushPendingUpdates();
70         }
71 }
72
73 // [EOF]
74 ?>