inc/classes/main/resolver/class_BaseResolver.php

   1 <?php
   2 /**
   3  * A generic resolver class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 BaseResolver extends BaseFrameworkSystem {
  25         /**
  26          * Validated command name
  27          */
  28         private $commandName = "";
  29
  30         /**
  31          * Prefix for local, remote or other resolver
  32          */
  33         private $commandPrefix = "";
  34
  35         /**
  36          * A controller instance
  37          */
  38         private $controllerInstance = null;
  39
  40         /**
  41          * Protected constructor
  42          *
  43          * @return      void
  44          */
  45         protected function __construct ($class) {
  46                 // Call parent constructor
  47                 parent::__construct($class);
  48
  49                 // Clean up a little
  50                 $this->removeNumberFormaters();
  51                 $this->removeSystemArray();
  52         }
  53
  54         /**
  55          * Setter for controller instance (this surely breaks a bit the MVC patterm)
  56          *
  57          * @param       $controllerInstance             An instance of the controller
  58          * @return      void
  59          */
  60         public final function setControllerInstance (Controller $controllerInstance) {
  61                 $this->controllerInstance = $controllerInstance;
  62         }
  63
  64         /**
  65          * Getter for controller instance (this surely breaks a bit the MVC patterm)
  66          *
  67          * @return      $controllerInstance             An instance of the controller
  68          */
  69         public final function getControllerInstance () {
  70                 return $this->controllerInstance;
  71         }
  72
  73         /**
  74          * Setter for command name
  75          *
  76          * @param       $commandName    Last validated command name
  77          * @return      void
  78          */
  79         protected final function setCommandName ($commandName) {
  80                 $this->commandName = $commandName;
  81         }
  82
  83         /**
  84          * Getter for command name
  85          *
  86          * @return      $commandName    Last validated command name
  87          */
  88         protected final function getCommandName () {
  89                 return $this->commandName;
  90         }
  91
  92         /**
  93          * Setter for command prefix
  94          *
  95          * @param       $commandPrefix  Last validated commandPrefix
  96          * @return      void
  97          */
  98         protected final function setCommandPrefix ($commandPrefix) {
  99                 $this->commandPrefix = $commandPrefix;
 100         }
 101
 102         /**
 103          * Checks wether the given command is valid
 104          *
 105          * @param       $commandName    The default command we shall execute
 106          * @return      $isValid                Wether the given command is valid
 107          * @throws      EmptyVariableException  Thrown if the given command is not set
 108          */
 109         public function isCommandValid ($commandName) {
 110                 // By default nothing shall be valid
 111                 $isValid = false;
 112
 113                 // Is a command set?
 114                 if (empty($commandName)) {
 115                         // Then thrown an exception here
 116                         throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
 117                 }
 118
 119                 // Now, let us create the full name of the command class
 120                 $class = sprintf("%s%sCommand",
 121                         $this->commandPrefix,
 122                         $this->convertToClassName($commandName)
 123                 );
 124
 125                 // Is this class already loaded?
 126                 if (class_exists($class)) {
 127                         // This class does exist. :-)
 128                         $isValid = true;
 129                 }
 130
 131                 // Debug output
 132                 //echo "<strong>----- ".__METHOD__." -----</strong><br />\n";
 133                 //print($class."<pre>");
 134                 //debug_print_backtrace();
 135                 //var_dump($isValid);
 136                 //print("</pre>");
 137
 138                 // Set command name
 139                 $this->setCommandName($commandName);
 140
 141                 // Return the result
 142                 return $isValid;
 143         }
 144 }
 145
 146 // [EOF]
 147 ?>