inc/classes/main/filter/checkboxes/class_RulesAcceptedFilter.php

   1 <?php
   2 /**
   3  * A filter for checking if the user has accepted the rules. This is mainly
   4  * used and done in registration process and should not be removed from your
   5  * application.
   6  *
   7  * @author              Roland Haeder <webmaster@ship-simu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.ship-simu.org
  12  *
  13  * This program is free software: you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation, either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  25  */
  26 class RulesAcceptedFilter extends BaseFrameworkSystem implements Filterable {
  27         /**
  28          * Protected constructor
  29          *
  30          * @return      void
  31          */
  32         protected function __construct () {
  33                 // Call parent constructor
  34                 parent::__construct(__CLASS__);
  35
  36                 // Set part description
  37                 $this->setObjectDescription("A filter for checking if rules where accepted");
  38
  39                 // Create unique ID number
  40                 $this->generateUniqueId();
  41
  42                 // Clean up a little
  43                 $this->removeNumberFormaters();
  44                 $this->removeSystemArray();
  45         }
  46
  47         /**
  48          * Creates an instance of this filter class
  49          *
  50          * @return      $filterInstance         An instance of this filter class
  51          */
  52         public final static function createRulesAcceptedFilter () {
  53                 // Get a new instance
  54                 $filterInstance = new RulesAcceptedFilter();
  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 the "rules" value from request
  69                 $rules = $requestInstance->getRequestElement('rules');
  70
  71                 // Was the "rules" value found in form? And is it set?
  72                 if (is_null($rules)) {
  73                         // Not found in form so stop processing here
  74                         $requestInstance->requestIsValid(false);
  75
  76                         // Add a message to the response
  77                         $responseInstance->addFatalMessage('rules_unchecked');
  78
  79                         // Abort here
  80                         return false;
  81                 }
  82         }
  83 }
  84
  85 // [EOF]
  86 ?>