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, 2009, 2010 Core Developer Team
   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          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Getter for command prefix
  48          *
  49          * @return      $commandPrefix  Last validated commandPrefix
  50          */
  51         protected final function getCommandPrefix () {
  52                 return $this->commandPrefix;
  53         }
  54
  55         /**
  56          * Setter for command prefix
  57          *
  58          * @param       $commandPrefix  Last validated commandPrefix
  59          * @return      void
  60          */
  61         protected final function setCommandPrefix ($commandPrefix) {
  62                 $this->commandPrefix = $commandPrefix;
  63         }
  64
  65         /**
  66          * Setter for command name
  67          *
  68          * @param       $commandName    Last validated command name
  69          * @return      void
  70          */
  71         protected final function setCommandName ($commandName) {
  72                 $this->commandName = $commandName;
  73         }
  74
  75         /**
  76          * Getter for command name
  77          *
  78          * @return      $commandName    Last validated command name
  79          */
  80         protected final function getCommandName () {
  81                 return $this->commandName;
  82         }
  83
  84         /**
  85          * Checks wether the given command is valid
  86          *
  87          * @param       $commandName    The default command we shall execute
  88          * @return      $isValid                Wether the given command is valid
  89          * @throws      EmptyVariableException  Thrown if given command is not set
  90          */
  91         public function isCommandValid ($commandName) {
  92                 // By default nothing shall be valid
  93                 $isValid = false;
  94
  95                 // Is a command set?
  96                 if (empty($commandName)) {
  97                         // Then thrown an exception here
  98                         throw new EmptyVariableException(array($this, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  99                 } // END - if
 100
 101                 // Create the full class name
 102                 $className = $this->getCommandPrefix() . $this->convertToClassName($commandName) . 'Command';
 103
 104                 // Now, let us create the full name of the command class
 105                 $this->setClassName($className);
 106
 107                 // Is this class already loaded?
 108                 if (class_exists($this->getClassName())) {
 109                         // This class does exist. :-)
 110                         $isValid = true;
 111                 } // END - if
 112
 113                 // Set command name
 114                 $this->setCommandName($commandName);
 115
 116                 // Return the result
 117                 return $isValid;
 118         }
 119 }
 120
 121 // [EOF]
 122 ?>