application/city/classes/resolver/controller/html/class_CityHtmlControllerResolver.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Resolver\Controller;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Controller\InvalidControllerException;
   7 use Org\Mxchange\CoreFramework\Resolver\Controller\BaseControllerResolver;
   8 use Org\Mxchange\CoreFramework\Resolver\Controller\ControllerResolver;
   9
  10 /**
  11  * A resolver for resolving controllers locally
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2015 - 2023 City Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.shipsimu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class CityHtmlControllerResolver extends BaseControllerResolver implements ControllerResolver {
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41
  42                 // Set prefix to 'city_html'
  43                 $this->setClassPrefix('city_html');
  44         }
  45
  46         /**
  47          * Creates an instance of a resolver class with a given controller
  48          *
  49          * @param       $controllerName                         The controller we shall resolve
  50          * @return      $resolverInstance                       The prepared controller resolver instance
  51          * @throws      EmptyVariableException          Thrown if default controller is not set
  52          * @throws      InvalidControllerException      Thrown if default controller is invalid
  53          */
  54         public static final function createCityHtmlControllerResolver ($controllerName) {
  55                 // Create the new instance
  56                 $resolverInstance = new CityHtmlControllerResolver();
  57
  58                 // Is the variable $controllerName set and the controller is valid?
  59                 if (empty($controllerName)) {
  60                         // Then thrown an exception here
  61                         throw new EmptyVariableException(array($resolverInstance, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  62                 } elseif ($resolverInstance->isControllerValid('Org\Mxchange\City\Controller', $controllerName) === FALSE) {
  63                         // Invalid controller found
  64                         throw new InvalidControllerException(array($resolverInstance, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
  65                 }
  66
  67                 // Set namespace and controller name
  68                 $resolverInstance->setNamespace('Org\Mxchange\City\Controller');
  69                 $resolverInstance->setControllerName($controllerName);
  70
  71                 // Return the prepared instance
  72                 return $resolverInstance;
  73         }
  74
  75 }