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