Moved back out of "Generic" namespace, really no need
[core.git] / inc / main / classes / filter / verifier / class_UserStatusVerifierFilter.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Filter\Verifier\User;
4
5 // Import framework stuff
6 use CoreFramework\Registry\Registry;
7 use CoreFramework\Request\Requestable;
8 use CoreFramework\Response\Responseable;
9
10 /**
11  * A filter for checking if user status is GUEST or CONFIRMED.
12  *
13  * @author              Roland Haeder <webmaster@shipsimu.org>
14  * @version             0.0.0
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16  * @license             GNU GPL 3.0 or any newer version
17  * @link                http://www.shipsimu.org
18  *
19  * This program is free software: you can redistribute it and/or modify
20  * it under the terms of the GNU General Public License as published by
21  * the Free Software Foundation, either version 3 of the License, or
22  * (at your option) any later version.
23  *
24  * This program is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27  * GNU General Public License for more details.
28  *
29  * You should have received a copy of the GNU General Public License
30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
31  */
32 class UserStatusVerifierFilter extends BaseFilter implements Filterable {
33         /**
34          * Protected constructor
35          *
36          * @return      void
37          */
38         protected function __construct () {
39                 // Call parent constructor
40                 parent::__construct(__CLASS__);
41         }
42
43         /**
44          * Creates an instance of this filter class
45          *
46          * @return      $filterInstance         An instance of this filter class
47          */
48         public static final function createUserStatusVerifierFilter () {
49                 // Get a new instance
50                 $filterInstance = new UserStatusVerifierFilter();
51
52                 // Return the instance
53                 return $filterInstance;
54         }
55
56         /**
57          * Executes the filter with given request and response objects
58          *
59          * @param       $requestInstance        An instance of a class with an Requestable interface
60          * @param       $responseInstance       An instance of a class with an Responseable interface
61          * @return      void
62          */
63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
64                 // Get a user instance for comparison
65                 $userInstance = Registry::getRegistry()->getInstance('user');
66
67                 // Is the user account confirmed?
68                 if ((!$userInstance->isConfirmed()) && (!$userInstance->isGuest()) && ($requestInstance->getRequestElement('action') != $this->getConfigInstance()->getConfigEntry('action_status_problem'))) {
69                         // Request is invalid!
70                         $requestInstance->requestIsValid(FALSE);
71
72                         // Redirect to configured URL
73                         $responseInstance->redirectToConfiguredUrl('login_user_status');
74
75                         // Stop processing here
76                         exit();
77                 } // END - if
78         }
79
80 }