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