cf4cc1df711632b27c815a10d1e11a0ec3edc8b0
[core.git] / framework / main / classes / resolver / command / html / class_Html
1 <?php
2 /**
3  * A command resolver for local (non-hubbed) HTML commands
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class Html???CommandResolver extends BaseCommandResolver implements CommandResolver {
25         /**
26          * Last successfull resolved command
27          */
28         private $lastCommandInstance = null;
29
30         /**
31          * Protected constructor
32          *
33          * @return      void
34          */
35         protected function __construct () {
36                 // Call parent constructor
37                 parent::__construct(__CLASS__);
38
39                 // Set prefix to 'html'
40                 $this->setCommandPrefix('html');
41         }
42
43         /**
44          * Creates an instance of a Html command resolver with a given default command
45          *
46          * @param       $commandName                            The default command we shall execute
47          * @param       $appInstance                            An instance of a manageable application helper class
48          * @return      $resolverInstance                       The prepared command resolver instance
49          * @throws      EmptyVariableException          Thrown if the default command is not set
50          * @throws      InvalidCommandException         Thrown if the default command is invalid
51          */
52         public final static function createHtml???CommandResolver ($commandName, ManageableApplication $appInstance) {
53                 // Create the new instance
54                 $resolverInstance = new Html???CommandResolver();
55
56                 // Is the variable $commandName set and the command is valid?
57                 if (empty($commandName)) {
58                         // Then thrown an exception here
59                         throw new EmptyVariableException(array($resolverInstance, 'commandName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
60                 } elseif ($resolverInstance->isCommandValid($commandName) === FALSE) {
61                         // Invalid command found
62                         throw new InvalidCommandException(array($resolverInstance, $commandName), self::EXCEPTION_INVALID_COMMAND);
63                 }
64
65                 // Set the application instance
66                 $resolverInstance->setApplicationInstance($appInstance);
67
68                 // Return the prepared instance
69                 return $resolverInstance;
70         }
71 }
72
73 // [EOF]
74 ?>