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\Resolver\Controller\BaseControllerResolver;
   9 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
  10
  11 // Import SPL stuff
  12 use \InvalidArgumentException;
  13
  14 /**
  15  * A resolver for resolving controllers locally
  16  *
  17  * @author              Roland Haeder <webmaster@shipsimu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.shipsimu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class TestsConsoleControllerResolver extends BaseControllerResolver implements ControllerResolver {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45
  46                 // Set prefix to "TestsConsole"
  47                 $this->setClassPrefix('tests_console');
  48         }
  49
  50         /**
  51          * Creates an instance of a resolver class with a given command
  52          *
  53          * @param       $controllerName                         The controller we shall resolve
  54          * @return      $resolverInstance                       The prepared controller resolver instance
  55          * @throws      InvalidArgumentException                Thrown if default command is not set
  56          * @throws      InvalidControllerException      Thrown if default controller is invalid
  57          */
  58         public static final function createTestsConsoleControllerResolver ($controllerName) {
  59                 // Create the new instance
  60                 $resolverInstance = new TestsConsoleControllerResolver();
  61
  62                 // Is the variable $controllerName set and the command is valid?
  63                 if (empty($controllerName)) {
  64                         // Then thrown an exception here
  65                         throw new InvalidArgumentException('Parameter "controllerName" is empty');
  66                 } elseif ($resolverInstance->isControllerValid('Org\Mxchange\CoreFramework\Tests\Controller', $controllerName) === false) {
  67                         // Invalid command found
  68                         throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
  69                 }
  70
  71                 // Set namespace and controller name
  72                 $resolverInstance->setNamespace('Org\Mxchange\CoreFramework\Tests\Controller');
  73                 $resolverInstance->setControllerName($controllerName);
  74
  75                 // Return the prepared instance
  76                 return $resolverInstance;
  77         }
  78
  79         /**
  80          * Resolves the default controller of the given command
  81          *
  82          * @return      $controllerInstance             A controller instance for the default
  83          *                                                                      command
  84          * @throws      InvalidControllerInstanceException      Thrown if $controllerInstance
  85          *                                                                                              is invalid
  86          */
  87         public function resolveController () {
  88                 // Init variables
  89                 $controllerName = '';
  90                 $controllerInstance = NULL;
  91
  92                 // Get namespace and command name
  93                 $controllerName = $this->getControllerName();
  94
  95                 // Get the command
  96                 $controllerInstance = $this->loadController($controllerName);
  97
  98                 // And validate it
  99                 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
 100                         // This command has an invalid instance!
 101                         throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
 102                 } // END - if
 103
 104                 // Set last controller
 105                 $this->setResolvedInstance($controllerInstance);
 106
 107                 // Return the maybe resolved instance
 108                 return $controllerInstance;
 109         }
 110
 111 }