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