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