application/ship-simu/main/filter/validator/class_RefillRequestValidatorFilter.php

   1 <?php
   2 /**
   3  * A filter for validating the refill request
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
   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 RefillRequestValidatorFilter extends BaseShipSimuFilter 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
  35         /**
  36          * Creates an instance of this filter class
  37          *
  38          * @return      $filterInstance         An instance of this filter class
  39          */
  40         public final static function createRefillRequestValidatorFilter () {
  41                 // Get a new instance
  42                 $filterInstance = new RefillRequestValidatorFilter();
  43
  44                 // Return the instance
  45                 return $filterInstance;
  46         }
  47
  48         /**
  49          * Executes the filter with given request and response objects
  50          *
  51          * @param       $requestInstance        An instance of a class with an Requestable interface
  52          * @param       $responseInstance       An instance of a class with an Responseable interface
  53          * @return      void
  54          * @todo        Maybe we need to added some more generic tests on the request here?
  55          * @throws      FilterChainException    If this filter fails to operate
  56          */
  57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  58                 // Execute the parent execute method
  59                 parent::execute($requestInstance, $responseInstance);
  60
  61                 // Are all required request fields set?
  62                 if (($requestInstance->isRequestElementSet('type') === false) || ($requestInstance->isRequestElementSet('amount') === false)) {
  63                         // Something important is missing
  64                         $requestInstance->requestIsValid(false);
  65
  66                         // Add a message to the response
  67                         $responseInstance->addFatalMessage('refill_page_required_fields_missing');
  68
  69                         // Abort here
  70                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  71                 } // END - if
  72         }
  73 }
  74
  75 // [EOF]
  76 ?>