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