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