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