3 namespace Org\Mxchange\CoreFramework\Resolver\Controller;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Controller\BaseController;
7 use Org\Mxchange\CoreFramework\Controller\InvalidControllerException;
8 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
9 use Org\Mxchange\CoreFramework\Resolver\Controller\BaseControllerResolver;
12 use \InvalidArgumentException;
15 * A resolver for resolving controllers locally
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class ConsoleControllerResolver extends BaseControllerResolver implements ControllerResolver {
38 * Protected constructor
42 private function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
46 // Set prefix to "Console"
47 $this->setClassPrefix('console');
51 * Creates an instance of a resolver class with a given controller
53 * @param $namespace Namespace to look in
54 * @param $controllerName The controller we shall resolve
55 * @return $resolverInstance The prepared controller resolver instance
56 * @throws InvalidArgumentException Thrown if default controller is not set
57 * @throws InvalidControllerException Thrown if default controller is invalid
59 public static final function createConsoleControllerResolver (string $namespace, string $controllerName) {
60 // Create the new instance
61 $resolverInstance = new ConsoleControllerResolver();
63 // Is the variable $controllerName set and the controller is valid?
64 if (empty($namespace)) {
65 // Then thrown an exception here
66 throw new InvalidArgumentException('Parameter "namespace" is empty');
67 } elseif (empty($controllerName)) {
68 // Then thrown an exception here
69 throw new InvalidArgumentException('Parameter "controllerName" is empty');
70 } elseif ($resolverInstance->isControllerValid($namespace, $controllerName) === false) {
71 // Invalid controller found
72 throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
75 // Set controller name
76 $resolverInstance->setControllerName($controllerName);
78 // Return the prepared instance
79 return $resolverInstance;