3 namespace CoreFramework\Resolver\Controller;
5 // Import framework stuff
6 use CoreFramework\Controller\BaseController;
7 use CoreFramework\Generic\EmptyVariableException;
8 use CoreFramework\Manager\ManageableApplication;
9 use CoreFramework\Resolver\Controller\ControllerResolver;
10 use CoreFramework\Resolver\Controller\BaseControllerResolver;
13 * A resolver for resolving controllers locally
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class HtmlControllerResolver extends BaseControllerResolver implements ControllerResolver {
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
44 // Set prefix to 'Html'
45 $this->setClassPrefix('html');
49 * Creates an instance of a resolver class with a given controller
51 * @param $namespace Namespace to look in
52 * @param $controllerName The controller we shall resolve
53 * @param $applicationInstance An instance of a manageable application helper class
54 * @return $resolverInstance The prepared controller resolver instance
55 * @throws EmptyVariableException Thrown if default controller is not set
56 * @throws InvalidControllerException Thrown if default controller is invalid
58 public static final function createHtmlControllerResolver ($namespace, $controllerName, ManageableApplication $applicationInstance) {
59 // Create the new instance
60 $resolverInstance = new HtmlControllerResolver();
62 // Is the variable $controllerName set and the controller is valid?
63 if (empty($controllerName)) {
64 // Then thrown an exception here
65 throw new EmptyVariableException(array($resolverInstance, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
66 } elseif ($resolverInstance->isControllerValid($namespace, $controllerName) === FALSE) {
67 // Invalid controller found
68 throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
71 // Set the application instance
72 $resolverInstance->setApplicationInstance($applicationInstance);
74 // Set controller name
75 $resolverInstance->setControllerName($controllerName);
77 // Return the prepared instance
78 return $resolverInstance;