]> git.mxchange.org Git - core.git/blob - framework/main/interfaces/resolver/commands/class_CommandResolver.php
Continued:
[core.git] / framework / main / interfaces / resolver / commands / class_CommandResolver.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Resolver\Command;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Request\Requestable;
7 use Org\Mxchange\CoreFramework\Resolver\Resolver;
8
9 /**
10  * An instance for command resolver classes
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 interface CommandResolver extends Resolver {
32         /**
33          * Getter for command name
34          *
35          * @return      $commandName    Last validated command name
36          */
37         function getCommandName ();
38
39         /**
40          * Returns an command instance for a given request class or null if
41          * it was not found
42          *
43          * @param       $requestInstance        An instance of a Requestable class
44          * @return      $commandInstance        An instance of the resolved command
45          * @throws      InvalidCommandException         Thrown if $commandName is invalid
46          * @throws      UnexpectedValueException        Thrown if $commandInstance is an invalid instance
47          */
48         function resolveCommandByRequest (Requestable $requestInstance);
49
50         /**
51          * Resolves the command by its direct name and returns an instance of its class
52          *
53          * @param       $namespace                      Namespace to look in
54          * @param       $commandName            The direct command name we shall resolve
55          * @return      $commandInstance        An instance of the command class
56          * @throws      InvalidCommandException         Thrown if $commandName is invalid
57          */
58         function resolveCommand (string $namespace, string $commandName);
59
60 }