3 namespace CoreFramework\Resolver\Command;
5 // Import framework stuff
6 use CoreFramework\Manager\ManageableApplication;
9 * A command resolver for local (non-hubbed) web commands
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class ConsoleCommandResolver extends BaseCommandResolver implements CommandResolver {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
40 // Set prefix to "Console"
41 $this->setClassPrefix('console');
45 * Creates an instance of a Console command resolver with a given default command
47 * @param $commandName The default command we shall execute
48 * @param $applicationInstance An instance of a manageable application helper class
49 * @return $resolverInstance The prepared command resolver instance
50 * @throws EmptyVariableException Thrown if default command is not set
51 * @throws InvalidCommandException Thrown if default command is invalid
53 public static final function createConsoleCommandResolver ($commandName, ManageableApplication $applicationInstance) {
54 // Create the new instance
55 $resolverInstance = new ConsoleCommandResolver();
57 // Is the variable $commandName set and the command is valid?
58 if (empty($commandName)) {
59 // Then thrown an exception here
60 throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
61 } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
62 // Invalid command found
63 throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
66 // Set the application instance
67 $resolverInstance->setApplicationInstance($applicationInstance);
69 // Return the prepared instance
70 return $resolverInstance;