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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Daemon\Filter;
   4
   5 // Import own stuff
   6 use Org\Mxchange\City\Filter\BaseCityFilter;
   7
   8 // Import framework stuff
   9 use Org\Mxchange\CoreFramework\Filter\Filterable;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\CoreFramework\Response\Responseable;
  12
  13 /**
  14  * A PhpRequirements filter for cities
  15  *
  16  * @author              Roland Haeder <webmaster@shipsimu.org>
  17  * @version             0.0.0
  18  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  19  * @license             GNU GPL 3.0 or any newer version
  20  * @link                http://www.shipsimu.org
  21  *
  22  * This program is free software: you can redistribute it and/or modify
  23  * it under the terms of the GNU General Public License as published by
  24  * the Free Software Foundation, either version 3 of the License, or
  25  * (at your option) any later version.
  26  *
  27  * This program is distributed in the hope that it will be useful,
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  * GNU General Public License for more details.
  31  *
  32  * You should have received a copy of the GNU General Public License
  33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  34  */
  35 class CityDaemonPhpRequirementsFilter extends BaseCityFilter implements Filterable {
  36         /**
  37          * Protected constructor
  38          *
  39          * @return      void
  40          */
  41         protected function __construct () {
  42                 // Call parent constructor
  43                 parent::__construct(__CLASS__);
  44         }
  45
  46         /**
  47          * Creates an instance of this filter class
  48          *
  49          * @return      $filterInstance         An instance of this filter class
  50          */
  51         public static final function createCityDaemonPhpRequirementsFilter () {
  52                 // Get a new instance
  53                 $filterInstance = new CityDaemonPhpRequirementsFilter();
  54
  55                 // Return the instance
  56                 return $filterInstance;
  57         }
  58
  59         /**
  60          * Executes the filter with given request and response objects
  61          *
  62          * @param       $requestInstance        An instance of a class with an Requestable interface
  63          * @param       $responseInstance       An instance of a class with an Responseable interface
  64          * @return      void
  65          * @throws      FilterChainException    If a required PHP function is not available
  66          * @todo        Add more test and try to add an extra message to the thrown exception
  67          */
  68         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // By default, the requirement check is passed and zero checks are failed
  70                 $checkPassed = TRUE;
  71                 $checksFailed = 0;
  72
  73                 // Are all tests passed?
  74                 if ($checkPassed === FALSE) {
  75                         // Throw an exception
  76                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  77                 } // END - if
  78         }
  79 }