93c04fe2608eb2bc2971b96bf3236d13c8147b7a
[core.git] / framework / main / classes / resolver / command / html / class_HtmlCommandResolver.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Resolver\Command;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Command\InvalidCommandException;
7 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
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) HTML 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 HtmlCommandResolver extends BaseCommandResolver implements CommandResolver {
36         /**
37          * Last successfull resolved command
38          */
39         private $lastCommandInstance = NULL;
40
41         /**
42          * Protected constructor
43          *
44          * @return      void
45          */
46         protected function __construct () {
47                 // Call parent constructor
48                 parent::__construct(__CLASS__);
49
50                 // Set prefix to "html"
51                 $this->setClassPrefix('html');
52         }
53
54         /**
55          * Creates an instance of a Html command resolver with a given default command
56          *
57          * @param       $commandName                            The default command we shall execute
58          * @param       $applicationInstance            An instance of a manageable application helper class
59          * @return      $resolverInstance                       The prepared command resolver instance
60          * @throws      InvalidArgumentException        Thrown if default command is not set
61          * @throws      InvalidCommandException         Thrown if default command is invalid
62          */
63         public static final function createHtmlCommandResolver ($commandName, ManageableApplication $applicationInstance) {
64                 // Create the new instance
65                 $resolverInstance = new HtmlCommandResolver();
66
67                 // Is the variable $commandName set and the command is valid?
68                 if (empty($commandName)) {
69                         // Then thrown an exception here
70                         throw new InvalidArgumentException('Parameter "commandName" is empty');
71                 } elseif ($resolverInstance->isCommandValid($commandName) === false) {
72                         // Invalid command found
73                         throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
74                 }
75
76                 // Return the prepared instance
77                 return $resolverInstance;
78         }
79
80 }