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