git.mxchange.org Git - hub.git/blob

   1 <?php
   2 // Own namespace
   3 namespace Org\Shipsimu\Hub\Filter\Bootstrap\Cruncher\Activation;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filter\Filterable;
   7 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
   8 use Org\Mxchange\CoreFramework\Request\Requestable;
   9 use Org\Mxchange\CoreFramework\Response\Responseable;
  10
  11 /**
  12  * A GenericActivation filter for bootstrapping crunchers
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2011 - 2014 - 2018 Hub Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class CruncherBootstrapGenericActivationFilter extends BaseCruncherFilter implements Filterable {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42         }
  43
  44         /**
  45          * Creates an instance of this filter class
  46          *
  47          * @return      $filterInstance         An instance of this filter class
  48          */
  49         public final static function createCruncherBootstrapGenericActivationFilter () {
  50                 // Get a new instance
  51                 $filterInstance = new CruncherBootstrapGenericActivationFilter();
  52
  53                 // Return the instance
  54                 return $filterInstance;
  55         }
  56
  57         /**
  58          * Executes the filter with given request and response objects
  59          *
  60          * @param       $requestInstance        An instance of a class with an Requestable interface
  61          * @param       $responseInstance       An instance of a class with an Responseable interface
  62          * @return      void
  63          * @todo        Maybe we want to do somthing more here?
  64          */
  65         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  66                 // Get a cruncher instance
  67                 $cruncherInstance = GenericRegistry::getRegistry()->getInstance('cruncher');
  68
  69                 // Set the flag
  70                 $cruncherInstance->enableIsActive();
  71
  72                 // Debug message
  73                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BOOTSTRAP: The cruncher has been activated.');
  74         }
  75
  76 }