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