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