3 namespace Org\Mxchange\City\Resolver\Command;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Resolver\Command\BaseCommandResolver;
7 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
10 * A command resolver for console commands
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2015 - 2023 City Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 class CityConsoleCommandResolver extends BaseCommandResolver implements CommandResolver {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
41 // Set prefix to "CityConsole"
42 $this->setClassPrefix('city_console');
46 * Creates an instance of a CityConsole command resolver with a given default command
48 * @param $commandName The default command we shall execute
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 createCityConsoleCommandResolver ($commandName) {
54 // Create the new instance
55 $resolverInstance = new CityConsoleCommandResolver();
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('Org\Mxchange\City\Command', $commandName) === FALSE) {
62 // Invalid command found
63 throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
67 $resolverInstance->setNamespace('Org\Mxchange\City\Command');
69 // Return the prepared instance
70 return $resolverInstance;