framework/main/classes/resolver/controller/console/class_ConsoleControllerResolver.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Resolver\Controller;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Controller\BaseController;
   7 use Org\Mxchange\CoreFramework\Controller\InvalidControllerException;
   8 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   9 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
  10 use Org\Mxchange\CoreFramework\Resolver\Controller\BaseControllerResolver;
  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 - 2023 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 ConsoleControllerResolver extends BaseControllerResolver implements ControllerResolver {
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         private function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46
  47                 // Set prefix to "Console"
  48                 $this->setClassPrefix('console');
  49         }
  50
  51         /**
  52          * Creates an instance of a resolver class with a given controller
  53          *
  54          * @param       $namespace                                      Namespace to look in
  55          * @param       $controllerName                         The controller we shall resolve
  56          * @return      $resolverInstance                       The prepared controller resolver instance
  57          * @throws      InvalidArgumentException                Thrown if default controller is not set
  58          * @throws      InvalidControllerException      Thrown if default controller is invalid
  59          */
  60         public static final function createConsoleControllerResolver (string $namespace, string $controllerName) {
  61                 // Create the new instance
  62                 $resolverInstance = new ConsoleControllerResolver();
  63
  64                 // Is the variable $controllerName set and the controller is valid?
  65                 if (empty($namespace)) {
  66                         // Then thrown an exception here
  67                         throw new InvalidArgumentException('Parameter "namespace" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
  68                 } elseif (empty($controllerName)) {
  69                         // Then thrown an exception here
  70                         throw new InvalidArgumentException('Parameter "controllerName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
  71                 } elseif ($resolverInstance->isControllerValid($namespace, $controllerName) === false) {
  72                         // Invalid controller found
  73                         throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
  74                 }
  75
  76                 // Set controller name
  77                 $resolverInstance->setControllerName($controllerName);
  78
  79                 // Return the prepared instance
  80                 return $resolverInstance;
  81         }
  82
  83 }