]> git.mxchange.org Git - core.git/blobdiff - inc/classes/main/resolver/command/console/class_ConsoleCommandResolver.php
Copyright year updated, converted double->single quotes
[core.git] / inc / classes / main / resolver / command / console / class_ConsoleCommandResolver.php
index 3cbeccb387589f0aa5c06f483dee14288c54c7d2..bfc51901cc547368856b693674d2dded3e7e5493 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * A command resolver for local (non-hubbed) web commands
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class ConsoleCommandResolver extends BaseCommandResolver implements CommandResolver {
-       /**
-        * Last successfull resolved command
-        */
-       private $lastCommandInstance = null;
-
        /**
         * Protected constructor
         *
@@ -37,19 +32,19 @@ class ConsoleCommandResolver extends BaseCommandResolver implements CommandResol
                parent::__construct(__CLASS__);
 
                // Set prefix to "Console"
-               $this->setCommandPrefix('Console');
+               $this->setClassPrefix('Console');
        }
 
        /**
         * Creates an instance of a Console command resolver with a given default command
         *
         * @param       $commandName                            The default command we shall execute
-        * @param       $appInstance                            An instance of a manageable application helper class
+        * @param       $applicationInstance            An instance of a manageable application helper class
         * @return      $resolverInstance                       The prepared command resolver instance
         * @throws      EmptyVariableException          Thrown if default command is not set
         * @throws      InvalidCommandException         Thrown if default command is invalid
         */
-       public final static function createConsoleCommandResolver ($commandName, ManageableApplication $appInstance) {
+       public static final function createConsoleCommandResolver ($commandName, ManageableApplication $applicationInstance) {
                // Create the new instance
                $resolverInstance = new ConsoleCommandResolver();
 
@@ -57,13 +52,13 @@ class ConsoleCommandResolver extends BaseCommandResolver implements CommandResol
                if (empty($commandName)) {
                        // Then thrown an exception here
                        throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-               } elseif ($resolverInstance->isCommandValid($commandName) === false) {
+               } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
                        // Invalid command found
                        throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
                }
 
                // Set the application instance
-               $resolverInstance->setApplicationInstance($appInstance);
+               $resolverInstance->setApplicationInstance($applicationInstance);
 
                // Return the prepared instance
                return $resolverInstance;
@@ -83,16 +78,18 @@ class ConsoleCommandResolver extends BaseCommandResolver implements CommandResol
        public function resolveCommandByRequest (Requestable $requestInstance) {
                // Init variables
                $commandName = '';
-               $commandInstance = null;
+               $commandInstance = NULL;
 
                // This goes fine so let's resolve the command
                $commandName = $requestInstance->getRequestElement('command');
 
                // Is the command empty? Then fall back to default command
-               if (empty($commandName)) $commandName = $this->getConfigInstance()->getConfigEntry('default_console_command');
+               if (empty($commandName)) {
+                       $commandName = $this->getConfigInstance()->getConfigEntry('default_console_command');
+               } // END - if
 
                // Check if command is valid
-               if ($this->isCommandValid($commandName) === false) {
+               if ($this->isCommandValid($commandName) === FALSE) {
                        // This command is invalid!
                        throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
                } // END - if
@@ -107,7 +104,7 @@ class ConsoleCommandResolver extends BaseCommandResolver implements CommandResol
                } // END - if
 
                // Set last command
-               $this->lastCommandInstance = $commandInstance;
+               $this->setResolvedInstance($commandInstance);
 
                // Return the resolved command instance
                return $commandInstance;
@@ -122,16 +119,18 @@ class ConsoleCommandResolver extends BaseCommandResolver implements CommandResol
         */
        public function resolveCommand ($commandName) {
                // Initiate the instance variable
-               $commandInstance = null;
+               $commandInstance = NULL;
 
                // Is the command empty? Then fall back to default command
-               if (empty($commandName)) $commandName = $this->getConfigInstance()->getConfigEntry('default_console_command');
+               if (empty($commandName)) {
+                       $commandName = $this->getConfigInstance()->getConfigEntry('default_console_command');
+               } // END - if
 
                // Check if command is valid
-               if ($this->isCommandValid($commandName) === false) {
+               if ($this->isCommandValid($commandName) === FALSE) {
                        // This command is invalid!
                        throw new InvalidCommandException(array($this, $commandName), self::EXCEPTION_INVALID_COMMAND);
-               }
+               } // END - if
 
                // Get the command
                $commandInstance = $this->loadCommand($commandName);
@@ -150,10 +149,10 @@ class ConsoleCommandResolver extends BaseCommandResolver implements CommandResol
         */
        private function loadCommand ($commandName) {
                // Init command instance
-               $commandInstance = null;
+               $commandInstance = NULL;
 
                // Create class name
-               $className = $this->getCommandPrefix() . $this->convertToClassName($commandName) . 'Command';
+               $className = $this->getClassPrefix() . $this->convertToClassName($commandName) . 'Command';
 
                // Create command class name
                $this->setClassName($className);