application/hub/main/filter/node/class_NodeInitializationFilter.php

   1 <?php
   2 /**
   3  * A Initialization filter for nodes
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class NodeInitializationFilter extends BaseNodeFilter implements Filterable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this filter class
  37          *
  38          * @return      $filterInstance         An instance of this filter class
  39          */
  40         public static final function createNodeInitializationFilter () {
  41                 // Get a new instance
  42                 $filterInstance = new NodeInitializationFilter();
  43
  44                 // Return the instance
  45                 return $filterInstance;
  46         }
  47
  48         /**
  49          * Executes the filter with given request and response objects
  50          *
  51          * @param       $requestInstance        An instance of a class with an Requestable interface
  52          * @param       $responseInstance       An instance of a class with an Responseable interface
  53          * @return      void
  54          */
  55         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  56                 // The default node-mode is from our configuration
  57                 $nodeMode = $this->getConfigInstance()->getConfigEntry('node_default_mode');
  58                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE-INIT-FILTER[' . __METHOD__ . ':' . __LINE__ . ']: Got default node mode ' . $nodeMode . ' from configuration.');
  59
  60                 // Is the node 'mode' parameter set?
  61                 if ($requestInstance->isRequestElementSet('mode')) {
  62                         // Then use this which overrides the config entry temporarily
  63                         $nodeMode = $requestInstance->getRequestElement('mode');
  64                 } else {
  65                         // Set it for easier re-usage
  66                         $requestInstance->setRequestElement('mode', $nodeMode);
  67                 }
  68
  69                 // Now convert the node-mode in a class name
  70                 $className = 'Hub' . $this->convertToClassName($nodeMode) . 'Node';
  71
  72                 // And try to instance it
  73                 try {
  74                         // Get an instance
  75                         $nodeInstance = NodeObjectFactory::createNodeInstance($requestInstance, $responseInstance);
  76                 } catch (ClassNotFoundException $e) {
  77                         // This exception means, the node mode is invalid.
  78                         // @TODO Can we rewrite this to app_exit() ?
  79                         $this->debugBackTrace('[' . __METHOD__ . ':' . __LINE__ . ']:  node mode ' . $nodeMode . ' is invalid.');
  80                 }
  81
  82                 // Set the node instance in registry
  83                 Registry::getRegistry()->addInstance('node', $nodeInstance);
  84                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE-INIT-FILTER[' . __METHOD__ . ':' . __LINE__ . ']: Node ' . $nodeMode . ' has been added to registry.');
  85         }
  86 }
  87
  88 // [EOF]
  89 ?>