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