application/tests/classes/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\Generic\FrameworkInterface;
  10 use Org\Mxchange\CoreFramework\Resolver\Controller\BaseControllerResolver;
  11 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
  12
  13 // Import SPL stuff
  14 use \InvalidArgumentException;
  15
  16 /**
  17  * A resolver for resolving controllers locally
  18  *
  19  * @author              Roland Haeder <webmaster@shipsimu.org>
  20  * @version             0.0.0
  21  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  22  * @license             GNU GPL 3.0 or any newer version
  23  * @link                http://www.shipsimu.org
  24  *
  25  * This program is free software: you can redistribute it and/or modify
  26  * it under the terms of the GNU General Public License as published by
  27  * the Free Software Foundation, either version 3 of the License, or
  28  * (at your option) any later version.
  29  *
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * You should have received a copy of the GNU General Public License
  36  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  37  */
  38 class TestsConsoleControllerResolver extends BaseControllerResolver implements ControllerResolver {
  39         /**
  40          * Protected constructor
  41          *
  42          * @return      void
  43          */
  44         private function __construct () {
  45                 // Call parent constructor
  46                 parent::__construct(__CLASS__);
  47
  48                 // Set prefix to "TestsConsole"
  49                 $this->setClassPrefix('tests_console');
  50         }
  51
  52         /**
  53          * Creates an instance of a resolver class with a given command
  54          *
  55          * @param       $controllerName                         The controller we shall resolve
  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 (string $controllerName) {
  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', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
  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 }