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