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

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