Now in own repository for remote checkouts
[core.git] / inc / classes / main / filter / verifier / class_UserUnconfirmedVerifierFilter.php
1 <?php
2 /**
3  * A filter for checking if user status is UNCONFIRMED.
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 UserUnconfirmedVerifierFilter 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          * @param       $controllerInstance             An instance of a Controller class
39          * @return      $filterInstance                 An instance of this filter class
40          */
41         public final static function createUserUnconfirmedVerifierFilter (Controller $controllerInstance) {
42                 // Get a new instance
43                 $filterInstance = new UserUnconfirmedVerifierFilter();
44
45                 // Set the controller
46                 $filterInstance->setControllerInstance($controllerInstance);
47
48                 // Return the instance
49                 return $filterInstance;
50         }
51
52         /**
53          * Executes the filter with given request and response objects
54          *
55          * @param       $requestInstance        An instance of a class with an Requestable interface
56          * @param       $responseInstance       An instance of a class with an Responseable interface
57          * @return      void
58          */
59         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60                 // Get member class
61                 $userClass = $this->getConfigInstance()->readConfig('user_class');
62
63                 // Get a user instance for comparison
64                 $userInstance = call_user_func_array(array($userClass, 'createMemberByRequest'), array($requestInstance));
65
66                 // Is the email address valid?
67                 if ($userInstance->ifEmailAddressExists() === false) {
68                         // Request is invalid!
69                         $requestInstance->requestIsValid(false);
70
71                         // Redirect to configured URL
72                         $responseInstance->redirectToConfiguredUrl('user_unconfirmed_email_missing_url');
73
74                         // Stop processing here
75                         exit();
76                 } // END - if
77
78                 // Is the user account confirmed?
79                 if ($userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) != $this->getConfigInstance()->readConfig('user_status_unconfirmed')) {
80                         // Request is invalid!
81                         $requestInstance->requestIsValid(false);
82
83                         // Redirect to configured URL
84                         $responseInstance->redirectToConfiguredUrl('user_not_unconfirmed_url');
85
86                         // Stop processing here
87                         exit();
88                 } // END - if
89
90                 // Add this instance to registry
91                 Registry::getRegistry()->addInstance('user', $userInstance);
92         }
93 }
94
95 // [EOF]
96 ?>