62c254053f5dbee06efad5db48db8e0b82320a34
[core.git] / framework / main / tests / resolver / controller / class_TestsConsoleControllerResolver.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Tests\Resolver\Controller;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Controller\BaseController;
7 use Org\Mxchange\CoreFramework\Controller\Controller;
8 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
9 use Org\Mxchange\CoreFramework\Resolver\Controller\BaseControllerResolver;
10 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
11
12 // Import SPL stuff
13 use \InvalidArgumentException;
14
15 /**
16  * A resolver for resolving controllers locally
17  *
18  * @author              Roland Haeder <webmaster@shipsimu.org>
19  * @version             0.0.0
20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21  * @license             GNU GPL 3.0 or any newer version
22  * @link                http://www.shipsimu.org
23  *
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.
28  *
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.
33  *
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/>.
36  */
37 class TestsConsoleControllerResolver extends BaseControllerResolver implements ControllerResolver {
38         /**
39          * Protected constructor
40          *
41          * @return      void
42          */
43         protected function __construct () {
44                 // Call parent constructor
45                 parent::__construct(__CLASS__);
46
47                 // Set prefix to "TestsConsole"
48                 $this->setClassPrefix('tests_console');
49         }
50
51         /**
52          * Creates an instance of a resolver class with a given command
53          *
54          * @param       $controllerName                         The controller we shall resolve
55          * @param       $applicationInstance            An instance of a manageable application helper class
56          * @return      $resolverInstance                       The prepared controller resolver instance
57          * @throws      InvalidArgumentException                Thrown if default command is not set
58          * @throws      InvalidControllerException      Thrown if default controller is invalid
59          */
60         public static final function createTestsConsoleControllerResolver ($controllerName, ManageableApplication $applicationInstance) {
61                 // Create the new instance
62                 $resolverInstance = new TestsConsoleControllerResolver();
63
64                 // Is the variable $controllerName set and the command is valid?
65                 if (empty($controllerName)) {
66                         // Then thrown an exception here
67                         throw new InvalidArgumentException('Parameter "controllerName" is empty');
68                 } elseif ($resolverInstance->isControllerValid('Org\Mxchange\CoreFramework\Tests\Controller', $controllerName) === false) {
69                         // Invalid command found
70                         throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
71                 }
72
73                 // Set namespace and controller name
74                 $resolverInstance->setNamespace('Org\Mxchange\CoreFramework\Tests\Controller');
75                 $resolverInstance->setControllerName($controllerName);
76
77                 // Return the prepared instance
78                 return $resolverInstance;
79         }
80
81         /**
82          * Resolves the default controller of the given command
83          *
84          * @return      $controllerInstance             A controller instance for the default
85          *                                                                      command
86          * @throws      InvalidControllerInstanceException      Thrown if $controllerInstance
87          *                                                                                              is invalid
88          */
89         public function resolveController () {
90                 // Init variables
91                 $controllerName = '';
92                 $controllerInstance = NULL;
93
94                 // Get namespace and command name
95                 $controllerName = $this->getControllerName();
96
97                 // Get the command
98                 $controllerInstance = $this->loadController($controllerName);
99
100                 // And validate it
101                 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
102                         // This command has an invalid instance!
103                         throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
104                 } // END - if
105
106                 // Set last controller
107                 $this->setResolvedInstance($controllerInstance);
108
109                 // Return the maybe resolved instance
110                 return $controllerInstance;
111         }
112
113 }