application/tests/classes/resolver/controller/class_TestsConsoleControllerResolver.php

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