2d6452458d1a4d2a28334f85e3aa097d18e608a5
[core.git] / framework / main / classes / commands / console / class_ConsoleFuseCommand.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Command\Fuse;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
7 use Org\Mxchange\CoreFramework\Command\Commandable;
8 use Org\Mxchange\CoreFramework\Controller\Controller;
9 use Org\Mxchange\CoreFramework\Feature\FrameworkFeature;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
13
14 /**
15  * A Fuse console command
16  *
17  * @author              Roland Haeder <webmaster@ship-simu.org>
18  * @version             0.0.0
19 <<<<<<< HEAD:framework/main/classes/commands/console/class_ConsoleFuseCommand.php
20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 =======
22  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
23 >>>>>>> Some updates::inc/main/classes/commands/console/class_ConsoleFuseCommand.php
24  * @license             GNU GPL 3.0 or any newer version
25  * @link                http://www.ship-simu.org
26  *
27  * This program is free software: you can redistribute it and/or modify
28  * it under the terms of the GNU General Public License as published by
29  * the Free Software Foundation, either version 3 of the License, or
30  * (at your option) any later version.
31  *
32  * This program is distributed in the hope that it will be useful,
33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
35  * GNU General Public License for more details.
36  *
37  * You should have received a copy of the GNU General Public License
38  * along with this program. If not, see <http://www.gnu.org/licenses/>.
39  */
40 class ConsoleFuseCommand extends BaseCommand implements Commandable {
41         /**
42          * Protected constructor
43          *
44          * @return      void
45          */
46         protected function __construct () {
47                 // Call parent constructor
48                 parent::__construct(__CLASS__);
49         }
50
51         /**
52          * Creates an instance of this class
53          *
54          * @param       $resolverInstance       An instance of a command resolver class
55          * @return      $commandInstance        An instance a prepared command class
56          */
57         public final static function createConsoleFuseCommand (CommandResolver $resolverInstance) {
58                 // Get new instance
59                 $commandInstance = new ConsoleFuseCommand();
60
61                 // Set the application instance
62                 $commandInstance->setResolverInstance($resolverInstance);
63
64                 // Return the prepared instance
65                 return $commandInstance;
66         }
67
68         /**
69          * Executes the given command with given request and response objects
70          *
71          * @param       $requestInstance        An instance of a class with an Requestable interface
72          * @param       $responseInstance       An instance of a class with an Responseable interface
73          * @return      void
74          */
75         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
76                 // Is the feature available?
77                 if (!FrameworkFeature::isFeatureAvailable('fuse')) {
78                         // Feature not available, cannot continue
79                         self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] Feature "hub" not available.',
80                                 __METHOD__,
81                                 __LINE__
82                         ));
83
84                         // Abort here
85                         return;
86                 } // END - if
87
88                 // @TODO Unfinished
89                 $this->partialStub('Still unfinished! ;-)');
90         }
91
92         /**
93          * Adds extra filters to the given controller instance
94          *
95          * @param       $controllerInstance             A controller instance
96          * @param       $requestInstance                An instance of a class with an Requestable interface
97          * @return      void
98          */
99         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
100                 // Empty for now ...
101         }
102
103 }