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