d2849d8319dce06a6a4ac08696485a76f67189ea
[core.git] / inc / main / classes / commands / console / class_ConsoleFuseCommand.php
1 <?php
2 /**
3  * A Fuse console command
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 ConsoleFuseCommand extends BaseCommand implements Commandable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this class
37          *
38          * @param       $resolverInstance       An instance of a command resolver class
39          * @return      $commandInstance        An instance a prepared command class
40          */
41         public final static function createConsoleFuseCommand (CommandResolver $resolverInstance) {
42                 // Get new instance
43                 $commandInstance = new ConsoleFuseCommand();
44
45                 // Set the application instance
46                 $commandInstance->setResolverInstance($resolverInstance);
47
48                 // Return the prepared instance
49                 return $commandInstance;
50         }
51
52         /**
53          * Executes the given command with given request and response objects
54          *
55          * @param       $requestInstance        An instance of a class with an Requestable interface
56          * @param       $responseInstance       An instance of a class with an Responseable interface
57          * @return      void
58          */
59         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60                 // Is the feature available?
61                 if (!FrameworkFeature::isFeatureAvailable('fuse')) {
62                         // Feature not available, cannot continue
63                         self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Feature "hub" not available.',
64                                 __METHOD__,
65                                 __LINE__
66                         ));
67
68                         // Abort here
69                         return;
70                 } // END - if
71
72                 // @TODO Unfinished
73                 $this->partialStub('Still unfinished! ;-)');
74         }
75
76         /**
77          * Adds extra filters to the given controller instance
78          *
79          * @param       $controllerInstance             A controller instance
80          * @param       $requestInstance                An instance of a class with an Requestable interface
81          * @return      void
82          */
83         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
84                 // Empty for now ...
85         }
86 }
87
88 // [EOF]
89 ?>