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\Generic\FrameworkInterface;
9 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
10 use Org\Mxchange\CoreFramework\Resolver\Controller\BaseControllerResolver;
13 use \InvalidArgumentException;
16 * A resolver for resolving controllers locally
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class HtmlControllerResolver extends BaseControllerResolver implements ControllerResolver {
39 * Protected constructor
43 private function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
47 // Set prefix to 'Html'
48 $this->setClassPrefix('html');
52 * Creates an instance of a resolver class with a given controller
54 * @param $namespace Namespace to look in
55 * @param $controllerName The controller we shall resolve
56 * @return $resolverInstance The prepared controller resolver instance
57 * @throws InvalidArgumentException Thrown if default controller is not set
58 * @throws InvalidControllerException Thrown if default controller is invalid
60 public static final function createHtmlControllerResolver (string $namespace, string $controllerName) {
61 // Create the new instance
62 $resolverInstance = new HtmlControllerResolver();
64 // Are all parameter set and the controller is valid?
65 if (empty($namespace)) {
66 // Then thrown an exception here
67 throw new InvalidArgumentException('Parameter "namespace" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
68 } elseif (empty($controllerName)) {
69 // Then thrown an exception here
70 throw new InvalidArgumentException('Parameter "controllerName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
71 } elseif ($resolverInstance->isControllerValid($namespace, $controllerName) === false) {
72 // Invalid controller found
73 throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
76 // Set controller name
77 $resolverInstance->setControllerName($controllerName);
79 // Return the prepared instance
80 return $resolverInstance;