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

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