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