inc/classes/main/resolver/command/class_BaseCommandResolver.php

   1 <?php
   2 /**
   3  * A generic command 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 BaseCommandResolver extends BaseResolver {
  25         /**
  26          * Prefix for local, remote or other resolver
  27          */
  28         private $commandPrefix = "";
  29
  30         /**
  31          * Validated command name
  32          */
  33         private $commandName = "";
  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 ($className) {
  46                 // Call parent constructor
  47                 parent::__construct($className);
  48         }
  49
  50         /**
  51          * Setter for command prefix
  52          *
  53          * @param       $commandPrefix  Last validated commandPrefix
  54          * @return      void
  55          */
  56         protected final function setCommandPrefix ($commandPrefix) {
  57                 $this->commandPrefix = $commandPrefix;
  58         }
  59
  60         /**
  61          * Setter for command name
  62          *
  63          * @param       $commandName    Last validated command name
  64          * @return      void
  65          */
  66         protected final function setCommandName ($commandName) {
  67                 $this->commandName = $commandName;
  68         }
  69
  70         /**
  71          * Getter for command name
  72          *
  73          * @return      $commandName    Last validated command name
  74          */
  75         protected final function getCommandName () {
  76                 return $this->commandName;
  77         }
  78
  79         /**
  80          * Setter for controller instance (this surely breaks a bit the MVC patterm)
  81          *
  82          * @param       $controllerInstance             An instance of the controller
  83          * @return      void
  84          */
  85         public final function setControllerInstance (Controller $controllerInstance) {
  86                 $this->controllerInstance = $controllerInstance;
  87         }
  88
  89         /**
  90          * Getter for controller instance (this surely breaks a bit the MVC patterm)
  91          *
  92          * @return      $controllerInstance             An instance of the controller
  93          */
  94         public final function getControllerInstance () {
  95                 return $this->controllerInstance;
  96         }
  97
  98         /**
  99          * Checks wether the given command is valid
 100          *
 101          * @param       $commandName    The default command we shall execute
 102          * @return      $isValid                Wether the given command is valid
 103          * @throws      EmptyVariableException  Thrown if the given command is not set
 104          */
 105         public function isCommandValid ($commandName) {
 106                 // By default nothing shall be valid
 107                 $isValid = false;
 108
 109                 // Is a command set?
 110                 if (empty($commandName)) {
 111                         // Then thrown an exception here
 112                         throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
 113                 }
 114
 115                 // Now, let us create the full name of the command class
 116                 $className = sprintf("%s%sCommand",
 117                         $this->commandPrefix,
 118                         $this->convertToClassName($commandName)
 119                 );
 120
 121                 // Is this class already loaded?
 122                 if (class_exists($className)) {
 123                         // This class does exist. :-)
 124                         $isValid = true;
 125                 } // END - if
 126
 127                 // Debug output
 128                 //* DEBUG: */ $this->debugBacktrace();
 129
 130                 // Set command name
 131                 $this->setCommandName($commandName);
 132
 133                 // Return the result
 134                 return $isValid;
 135         }
 136 }
 137
 138 // [EOF]
 139 ?>