application/city/classes/filter/city_daemon/class_CityDaemonPhpRequirementsFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Daemon\Filter;
   4
   5 // Import application-specific stuff
   6 use Org\Mxchange\City\Filter\BaseCityFilter;
   7
   8 // Import framework stuff
   9 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
  10 use Org\Mxchange\CoreFramework\Filter\Filterable;
  11 use Org\Mxchange\CoreFramework\Request\Requestable;
  12 use Org\Mxchange\CoreFramework\Response\Responseable;
  13
  14 /**
  15  * A PhpRequirements filter for cities
  16  *
  17  * @author              Roland Haeder <webmaster@shipsimu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2015 - 2023 City 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 CityDaemonPhpRequirementsFilter extends BaseCityFilter implements Filterable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected 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 createCityDaemonPhpRequirementsFilter () {
  53                 // Get a new instance
  54                 $filterInstance = new CityDaemonPhpRequirementsFilter();
  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 a required PHP function is not available
  67          * @todo        Add more test and try to add an extra message to the thrown exception
  68          */
  69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  70                 // By default, the requirement check is passed and zero checks are failed
  71                 $checkPassed = TRUE;
  72                 $checksFailed = 0;
  73
  74                 // Are all tests passed?
  75                 if ($checkPassed === FALSE) {
  76                         // Throw an exception
  77                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  78                 }
  79         }
  80 }