Continued:
[core.git] / framework / main / classes / resolver / command / console / class_ConsoleCommandResolver.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Resolver\Command;
4
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;
9
10 // Import SPL stuff
11 use \InvalidArgumentException;
12
13 /**
14  * A command resolver for local (non-hubbed) web commands
15  *
16  * @author              Roland Haeder <webmaster@shipsimu.org>
17  * @version             0.0.0
18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.shipsimu.org
21  *
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.
26  *
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.
31  *
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/>.
34  */
35 class ConsoleCommandResolver extends BaseCommandResolver implements CommandResolver {
36         /**
37          * Protected constructor
38          *
39          * @return      void
40          */
41         protected function __construct () {
42                 // Call parent constructor
43                 parent::__construct(__CLASS__);
44
45                 // Set prefix to "Console"
46                 $this->setClassPrefix('console');
47         }
48
49         /**
50          * Creates an instance of a Console command resolver with a given default command
51          *
52          * @param       $commandName                            The default command we shall execute
53          * @return      $resolverInstance                       The prepared command resolver instance
54          * @throws      InvalidArgumentException        Thrown if default command is not set
55          * @throws      InvalidCommandException         Thrown if default command is invalid
56          */
57         public static final function createConsoleCommandResolver ($commandName) {
58                 // Create the new instance
59                 $resolverInstance = new ConsoleCommandResolver();
60
61                 // Is the variable $commandName set and the command is valid?
62                 if (empty($commandName)) {
63                         // Then thrown an exception here
64                         throw new InvalidArgumentException('Parameter "commandName" is empty');
65                 } elseif ($resolverInstance->isCommandValid($commandName) === false) {
66                         // Invalid command found
67                         throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
68                 }
69
70                 // Return the prepared instance
71                 return $resolverInstance;
72         }
73
74 }