application/hub/class_ApplicationHelper.php

   1 <?php
   2 /**
   3  * A class holding general data about the application and some methods for
   4  * the management including the entry point.
   5  *
   6  * E.g.:
   7  *
   8  * index.php?app=my_app
   9  *
  10  * You need to create a folder in the folder "application" named "my_app"
  11  * (without the quotes) and create a include file called
  12  * class_ApplicationHelper.php. You have to write the same class for your
  13  * application and implement the same interface called ManageableApplication
  14  * because this class include file will be searched for.
  15  *
  16  * It is good when you avoid more GET parameters to keep URLs short and sweet.
  17  * But sometimes you need some GET paramerers e.g. for your imprint or info page
  18  * or other linked pages which you have to create and state some informations.
  19  *
  20  * Please remember that this include file is being loaded *before* the class
  21  * loader is loading classes from "exceptions", "interfaces" and "main"!
  22  *
  23  * @author              Roland Haeder <webmaster@ship-simu.org>
  24  * @version             0.0
  25  * @copyright   Copyright(c) 2007 - 2008 Roland Haeder, 2009 Hub Developer Team
  26  * @license             GNU GPL 3.0 or any newer version
  27  *
  28  * This program is free software: you can redistribute it and/or modify
  29  * it under the terms of the GNU General Public License as published by
  30  * the Free Software Foundation, either version 3 of the License, or
  31  * (at your option) any later version.
  32  *
  33  * This program is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36  * GNU General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU General Public License
  39  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  40  */
  41 class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication, Registerable {
  42         /**
  43          * The version number of this application
  44          */
  45         private $appVersion = "";
  46
  47         /**
  48          * The human-readable name for this application
  49          */
  50         private $appName = "";
  51
  52         /**
  53          * The short uni*-like name for this application
  54          */
  55         private $shortName = "";
  56
  57         /**
  58          * An instance of this class
  59          */
  60         private static $thisInstance = null;
  61
  62         /**
  63          * Private constructor
  64          *
  65          * @return      void
  66          */
  67         protected function __construct () {
  68                 // Call parent constructor
  69                 parent::__construct(__CLASS__);
  70
  71                 // Tidy up a little
  72                 $this->removeSystemArray();
  73                 $this->removeNumberFormaters();
  74         }
  75
  76         /**
  77          * Getter for an instance of this class
  78          *
  79          * @return      $thisInstance   An instance of this class
  80          */
  81         public final static function getInstance () {
  82                 // Is the instance there?
  83                 if (is_null(self::$thisInstance)) {
  84                         self::$thisInstance = new ApplicationHelper();
  85                 }
  86
  87                 // Return the instance
  88                 return self::$thisInstance;
  89         }
  90
  91         /**
  92          * Getter for the version number
  93          *
  94          * @return      $appVersion     The application's version number
  95          */
  96         public final function getAppVersion () {
  97                 return $this->appVersion;
  98         }
  99         /**
 100          * Setter for the version number
 101          *
 102          * @param       $appVersion     The application's version number
 103          * @return      void
 104          */
 105         public final function setAppVersion ($appVersion) {
 106                 // Cast and set it
 107                 $this->appVersion = (string) $appVersion;
 108         }
 109
 110         /**
 111          * Getter for human-readable name
 112          *
 113          * @return      $appName        The application's human-readable name
 114          */
 115         public final function getAppName () {
 116                 return $this->appName;
 117         }
 118
 119         /**
 120          * Setter for human-readable name
 121          *
 122          * @param       $appName        The application's human-readable name
 123          * @return      void
 124          */
 125         public final function setAppName ($appName) {
 126                 // Cast and set it
 127                 $this->appName = (string) $appName;;
 128         }
 129
 130         /**
 131          * Getter for short uni*-like name
 132          *
 133          * @return      $shortName      The application's short uni*-like name
 134          */
 135         public final function getAppShortName () {
 136                 return $this->shortName;
 137         }
 138
 139         /**
 140          * Setter for short uni*-like name
 141          *
 142          * @param       $shortName      The application's short uni*-like name
 143          * @return      void
 144          */
 145         public final function setAppShortName ($shortName) {
 146                 // Cast and set it
 147                 $this->shortName = (string) $shortName;
 148         }
 149
 150         /**
 151          * Launches the hub system
 152          *
 153          * @return      void
 154          */
 155         public final function entryPoint () {
 156                 // --------------------- Init phase ---------------------
 157                 // The default node-mode is from our configuration
 158                 $nodeMode = $this->getConfigInstance()->readConfig('node_mode');
 159
 160                 // Prepare a ConsoleRequest class to catch all parameters
 161                 $requestInstance = ObjectFactory::createObjectByName('ConsoleRequest');
 162
 163                 // Is the node 'mode' parameter set?
 164                 if ($requestInstance->isRequestElementSet('mode')) {
 165                         // Then use this which overrides the config entry temporarily
 166                         $nodeMode = $requestInstance->getRequestElement('mode');
 167                 } else {
 168                         // Set it for easier re-usage
 169                         $requestInstance->setRequestElement('mode', $nodeMode);
 170                 }
 171
 172                 // Now convert the node-mode in a class name
 173                 $className = 'Hub' . $this->convertToClassName($nodeMode) . 'Node';
 174
 175                 // And try to instance it
 176                 try {
 177                         // Get an instance
 178                         $nodeInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
 179
 180                         // Set the app instance
 181                         $nodeInstance->setApplicationInstance($this);
 182                 } catch (ClassNotFoundException $e) {
 183                         // This means, the node mode is invalid!
 184                         // @TODO Can we rewrite this to app_die() ?
 185                         die('Node mode ' . $nodeMode . ' is invalid.' . "\n");
 186                 }
 187
 188                 // --------------------- Hub-id aquirement phase ---------------------
 189                 // Aquire a hub-id. This step generates on first launch anew one and
 190                 // on any later launches it will restore the hub-id from the database.
 191                 // A passed 'nickname=xxx' argument will be used to add some
 192                 // 'personality' to the hub.
 193                 $nodeInstance->aquireHubId($requestInstance);
 194
 195                 // --------------------- Bootstrapping phase ---------------------
 196                 // Try to bootstrap the node and pass the request instance to it for
 197                 // extra arguments which mostly override config entries
 198                 $nodeInstance->doBootstrapping($requestInstance);
 199         }
 200
 201         /**
 202          * Handle the indexed array of fatal messages and puts them out in an
 203          * acceptable fasion
 204          *
 205          * @param       $messageList    An array of fatal messages
 206          * @return      void
 207          */
 208         public function handleFatalMessages (array $messageList) {
 209                 // Walk through all messages
 210                 foreach ($messageList as $message) {
 211                         die("MSG:".$message);
 212                 }
 213         }
 214
 215         /**
 216          * Builds the master template's name
 217          *
 218          * @return      $masterTemplateName             Name of the master template
 219          */
 220         public function buildMasterTemplateName () {
 221                 return "node_main";
 222         }
 223 }
 224
 225 // [EOF]
 226 ?>