inc/main/classes/resolver/controller/image/class_ImageControllerResolver.php

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