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\Manager\ManageableApplication;
   8 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
   9 use Org\Mxchange\CoreFramework\Resolver\Controller\BaseControllerResolver;
  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 ConsoleControllerResolver 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 "Console"
  47                 $this->setClassPrefix('console');
  48         }
  49
  50         /**
  51          * Creates an instance of a resolver class with a given controller
  52          *
  53          * @param       $namespace                                      Namespace to look in
  54          * @param       $controllerName                         The controller we shall resolve
  55          * @param       $applicationInstance            An instance of a manageable application helper class
  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 ($namespace, $controllerName, ManageableApplication $applicationInstance) {
  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');
  68                 } elseif (empty($controllerName)) {
  69                         // Then thrown an exception here
  70                         throw new InvalidArgumentException('Parameter "controllerName" is empty');
  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 }