inc/classes/main/resolver/controller/class_BaseControllerResolver.php

   1 <?php
   2 /**
   3  * A generic controller resolver class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseControllerResolver extends BaseResolver {
  25         /**
  26          * Prefix for local, remote or other resolver
  27          */
  28         private $controllerPrefix = '';
  29
  30         /**
  31          * Validated controller name
  32          */
  33         private $controllerName = '';
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the real class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Setter for controller prefix
  48          *
  49          * @param       $controllerPrefix       Last validated controllerPrefix
  50          * @return      void
  51          */
  52         protected final function setControllerPrefix ($controllerPrefix) {
  53                 $this->controllerPrefix = $controllerPrefix;
  54         }
  55
  56         /**
  57          * Setter for controller name
  58          *
  59          * @param       $controllerName         Last validated controller name
  60          * @return      void
  61          */
  62         protected final function setControllerName ($controllerName) {
  63                 $this->controllerName = $controllerName;
  64         }
  65
  66         /**
  67          * Getter for controller name
  68          *
  69          * @return      $controllerName Last validated controller name
  70          */
  71         public final function getControllerName () {
  72                 return $this->controllerName;
  73         }
  74
  75         /**
  76          * Checks wether the given controller is valid
  77          *
  78          * @param       $controllerName         The default controller we shall execute
  79          * @return      $isValid                        Wether the given controller is valid
  80          * @throws      EmptyVariableException          Thrown if given controller is not set
  81          * @throws      DefaultControllerException      Thrown if default controller was not found
  82          */
  83         public function isControllerValid ($controllerName) {
  84                 // By default nothing shall be valid
  85                 $isValid = false;
  86
  87                 // Is a controller set?
  88                 if (empty($controllerName)) {
  89                         // Then thrown an exception here
  90                         throw new EmptyVariableException(array($this, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  91                 } // END - if
  92
  93                 // Create class name
  94                 $className = $this->controllerPrefix . $this->convertToClassName($controllerName) . 'Controller';
  95
  96                 // Now, let us create the full name of the controller class
  97                 $this->setClassName($className);
  98
  99                 // Try it hard to get an controller
 100                 while ($isValid === false) {
 101                         // Is this class already loaded?
 102                         if (class_exists($this->getClassName())) {
 103                                 // This class does exist. :-)
 104                                 $isValid = true;
 105                         } elseif ($this->getClassName() != $this->controllerPrefix.'DefaultNewsController') {
 106                                 // Set default controller
 107                                 $this->setClassName($this->controllerPrefix . 'DefaultNewsController');
 108                         } else {
 109                                 // All is tried, give it up here
 110                                 throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE);
 111                         }
 112                 } // END - while
 113
 114                 // Return the result
 115                 return $isValid;
 116         }
 117 }
 118
 119 // [EOF]
 120 ?>