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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\RulesCheckbox;
   4
   5 // Import framework stuff
   6 use CoreFramework\Filter\BaseFilter;
   7 use CoreFramework\Request\Requestable;
   8 use CoreFramework\Response\Responseable;
   9
  10 /**
  11  * A filter for checking if the user has accepted the rules. This is mainly
  12  * used and done in registration process and should not be removed from your
  13  * application.
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 class RulesAcceptedFilter extends BaseFilter implements Filterable {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this filter class
  47          *
  48          * @return      $filterInstance                 An instance of this filter class
  49          */
  50         public static final function createRulesAcceptedFilter () {
  51                 // Get a new instance
  52                 $filterInstance = new RulesAcceptedFilter();
  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          * @throws      FilterChainException    If this filter fails to operate
  65          */
  66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  67                 // Get the "rules" value from request
  68                 $rules = $requestInstance->getRequestElement('rules');
  69
  70                 // Was the "rules" value found in form? And is it set?
  71                 if (is_null($rules)) {
  72                         // Not found in form so stop processing here
  73                         $requestInstance->requestIsValid(FALSE);
  74
  75                         // Add a message to the response
  76                         $responseInstance->addFatalMessage('rules_unchecked');
  77
  78                         // Skip further processing
  79                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  80                 } // END - if
  81         }
  82
  83 }