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