Copyright notice updated, our first hub application introduced (which is incomplete)

[hub.git] / application / hub / main / filter / cruncher / class_CruncherInitializationFilter.php

diff --git a/application/hub/main/filter/cruncher/class_CruncherInitializationFilter.php b/application/hub/main/filter/cruncher/class_CruncherInitializationFilter.php
new file mode 100644 (file)
index 0000000..1c6c9af
--- /dev/null
+++ b/application/hub/main/filter/cruncher/class_CruncherInitializationFilter.php
@@ -0,0 +1,97 @@
+<?php
+/**
+ * A Initialization filter for crunchers
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class CruncherInitializationFilter extends BaseFilter implements Filterable {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates an instance of this filter class
+        *
+        * @return      $filterInstance         An instance of this filter class
+        */
+       public static final function createCruncherInitializationFilter () {
+               // Get a new instance
+               $filterInstance = new CruncherInitializationFilter();
+
+               // Return the instance
+               return $filterInstance;
+       }
+
+       /**
+        * Executes the filter with given request and response objects
+        *
+        * @param       $requestInstance        An instance of a class with an Requestable interface
+        * @param       $responseInstance       An instance of a class with an Responseable interface
+        * @return      void
+        * @todo        0% done
+        */
+       public function execute (Requestable $requestInstance, Responseable $responseInstance) {
+               // The default cruncher-mode is from our configuration
+               $cruncherMode = $this->getConfigInstance()->getConfigEntry('cruncher_default_mode');
+
+               // Is the cruncher 'mode' parameter set?
+               if ($requestInstance->isRequestElementSet('mode')) {
+                       // Then use this which overrides the config entry temporarily
+                       $cruncherMode = $requestInstance->getRequestElement('mode');
+               } else {
+                       // Set it for easier re-usage
+                       $requestInstance->setRequestElement('mode', $cruncherMode);
+               }
+
+               // Now convert the cruncher-mode in a class name
+               $className = 'Hub' . $this->convertToClassName($cruncherMode) . 'Cruncher';
+
+               // And try to instance it
+               try {
+                       // Get an instance
+                       $cruncherInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
+
+                       // Get a registry
+                       $appInstance = Registry::getRegistry()->getInstance('app');
+
+                       // Set the app instance
+                       $cruncherInstance->setApplicationInstance($appInstance);
+
+                       // Add cruncher-specific filters
+                       $cruncherInstance->addExtraFilters($requestInstance, $responseInstance);
+               } catch (ClassNotFoundException $e) {
+                       // This exception means, the cruncher mode is invalid.
+                       // @TODO Can we rewrite this to app_die() ?
+                       die('Cruncher mode ' . $cruncherMode . ' is invalid.' . "\n");
+               }
+
+               // Set the cruncher instance in registry
+               Registry::getRegistry()->addInstance('cruncher', $cruncherInstance);
+       }
+}
+
+// [EOF]
+?>