inc/classes/main/filter/validator/class_ConfirmCodeValidatorFilter.php

   1 <?php
   2 /**
   3  * A filter for checking if the the supplied confirmation code is valid
   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 ConfirmCodeValidatorFilter extends BaseFilter 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 ConfirmCode validation");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39         }
  40
  41         /**
  42          * Creates an instance of this filter class
  43          *
  44          * @return      $filterInstance         An instance of this filter class
  45          */
  46         public final static function createConfirmCodeValidatorFilter () {
  47                 // Get a new instance
  48                 $filterInstance = new ConfirmCodeValidatorFilter();
  49
  50                 // Return the instance
  51                 return $filterInstance;
  52         }
  53
  54         /**
  55          * Executes the filter with given request and response objects
  56          *
  57          * @param       $requestInstance        An instance of a class with an Requestable interface
  58          * @param       $responseInstance       An instance of a class with an Responseable interface
  59          * @return      void
  60          */
  61         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  62                 // Get confirmation code from request
  63                 $confirmCode = $requestInstance->getRequestElement('confirm');
  64
  65                 // Is this code set?
  66                 if (is_null($confirmCode)) {
  67                         // Is not in request
  68                         $requestInstance->requestIsValid(false);
  69
  70                         // Add a message to the response
  71                         $responseInstance->addFatalMessage('confirm_code_unset');
  72
  73                         // Abort here
  74                         return false;
  75                 } elseif (empty($confirmCode)) {
  76                         // Email is empty
  77                         $requestInstance->requestIsValid(false);
  78
  79                         // Add a message to the response
  80                         $responseInstance->addFatalMessage('confirm_code_empty');
  81
  82                         // Abort here
  83                         return false;
  84                 }
  85         }
  86 }
  87
  88 // [EOF]
  89 ?>