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 BaseFilter 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
  43         /**
  44          * Creates an instance of this filter class
  45          *
  46          * @return      $filterInstance         An instance of this filter class
  47          */
  48         public final static function createRulesAcceptedFilter () {
  49                 // Get a new instance
  50                 $filterInstance = new RulesAcceptedFilter();
  51
  52                 // Return the instance
  53                 return $filterInstance;
  54         }
  55
  56         /**
  57          * Executes the filter with given request and response objects
  58          *
  59          * @param       $requestInstance        An instance of a class with an Requestable interface
  60          * @param       $responseInstance       An instance of a class with an Responseable interface
  61          * @return      void
  62          */
  63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  64                 // Get the "rules" value from request
  65                 $rules = $requestInstance->getRequestElement('rules');
  66
  67                 // Was the "rules" value found in form? And is it set?
  68                 if (is_null($rules)) {
  69                         // Not found in form so stop processing here
  70                         $requestInstance->requestIsValid(false);
  71
  72                         // Add a message to the response
  73                         $responseInstance->addFatalMessage('rules_unchecked');
  74
  75                         // Skip further processing
  76                         return false;
  77                 }
  78         }
  79 }
  80
  81 // [EOF]
  82 ?>