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\Controller\InvalidControllerException;
   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 - 2020 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          * @return      $resolverInstance                       The prepared controller resolver instance
  56          * @throws      InvalidArgumentException                Thrown if default command is not set
  57          * @throws      InvalidControllerException      Thrown if default controller is invalid
  58          */
  59         public static final function createTestsConsoleControllerResolver ($controllerName) {
  60                 // Create the new instance
  61                 $resolverInstance = new TestsConsoleControllerResolver();
  62
  63                 // Is the variable $controllerName set and the command is valid?
  64                 if (empty($controllerName)) {
  65                         // Then thrown an exception here
  66                         throw new InvalidArgumentException('Parameter "controllerName" is empty');
  67                 } elseif ($resolverInstance->isControllerValid('Org\Mxchange\CoreFramework\Tests\Controller', $controllerName) === false) {
  68                         // Invalid command found
  69                         throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
  70                 }
  71
  72                 // Set namespace and controller name
  73                 $resolverInstance->setNamespace('Org\Mxchange\CoreFramework\Tests\Controller');
  74                 $resolverInstance->setControllerName($controllerName);
  75
  76                 // Return the prepared instance
  77                 return $resolverInstance;
  78         }
  79
  80         /**
  81          * Resolves the default controller of the given command
  82          *
  83          * @return      $controllerInstance             A controller instance for the default
  84          *                                                                      command
  85          * @throws      InvalidControllerInstanceException      Thrown if $controllerInstance
  86          *                                                                                              is invalid
  87          */
  88         public function resolveController () {
  89                 // Init variables
  90                 $controllerName = '';
  91                 $controllerInstance = NULL;
  92
  93                 // Get namespace and command name
  94                 $controllerName = $this->getControllerName();
  95
  96                 // Get the command
  97                 $controllerInstance = $this->loadController($controllerName);
  98
  99                 // And validate it
 100                 if ((!is_object($controllerInstance)) || (!$controllerInstance instanceof Controller)) {
 101                         // This command has an invalid instance!
 102                         throw new InvalidControllerInstanceException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
 103                 } // END - if
 104
 105                 // Set last controller
 106                 $this->setResolvedInstance($controllerInstance);
 107
 108                 // Return the maybe resolved instance
 109                 return $controllerInstance;
 110         }
 111
 112 }