inc/classes/main/filter/verifier/class_UserUnconfirmedVerifierFilter.php

   1 <?php
   2 /**
   3  * A filter for checking if the user status is UNCONFIRMED
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class UserUnconfirmedVerifierFilter extends BaseFrameworkSystem implements Filterable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set part description
  35                 $this->setObjectDescription("A filter for checking if the user account is unconfirmed");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeNumberFormaters();
  42                 $this->removeSystemArray();
  43         }
  44
  45         /**
  46          * Creates an instance of this filter class
  47          *
  48          * @return      $filterInstance         An instance of this filter class
  49          */
  50         public final static 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 = User::createUserByRequest($requestInstance);
  68
  69                 // Is the user account confirmed?
  70                 if ($userInstance->getField('user_status') != $this->getConfigInstance()->readConfig('user_status_unconfirmed')) {
  71                         // Request is invalid!
  72                         $requestInstance->requestIsValid(false);
  73
  74                         // Redirect to configured URL
  75                         $responseInstance->redirectToConfiguredUrl('login_user_unconfirmed_url');
  76
  77                         // Stop processing here
  78                         exit();
  79                 } // END - if
  80
  81                 // Add this instance to registry
  82                 Registry::getRegistry()->addInstance('user', $userInstance);
  83         }
  84 }
  85
  86 // [EOF]
  87 ?>