inc/classes/main/resolver/action/class_BaseActionResolver.php

   1 <?php
   2 /**
   3  * A generic action resolver class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   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 BaseActionResolver extends BaseResolver {
  25         /**
  26          * Prefix for local, remote or other resolver
  27          */
  28         private $actionPrefix = "";
  29
  30         /**
  31          * Validated action name
  32          */
  33         private $actionName = "";
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct ($className) {
  41                 // Call parent constructor
  42                 parent::__construct($className);
  43         }
  44
  45         /**
  46          * Setter for action prefix
  47          *
  48          * @param       $actionPrefix   Last validated actionPrefix
  49          * @return      void
  50          */
  51         protected final function setActionPrefix ($actionPrefix) {
  52                 $this->actionPrefix = $actionPrefix;
  53         }
  54
  55         /**
  56          * Setter for action name
  57          *
  58          * @param       $actionName     Last validated action name
  59          * @return      void
  60          */
  61         protected final function setActionName ($actionName) {
  62                 $this->actionName = $actionName;
  63         }
  64
  65         /**
  66          * Getter for action name
  67          *
  68          * @return      $actionName     Last validated action name
  69          */
  70         protected final function getActionName () {
  71                 return $this->actionName;
  72         }
  73
  74         /**
  75          * Checks wether the given action is valid
  76          *
  77          * @param       $actionName     The default action we shall execute
  78          * @return      $isValid                Wether the given action is valid
  79          * @throws      EmptyVariableException  Thrown if the given action is not set
  80          */
  81         public function isActionValid ($actionName) {
  82                 // By default nothing shall be valid
  83                 $isValid = false;
  84
  85                 // Is a action set?
  86                 if (empty($actionName)) {
  87                         // Then thrown an exception here
  88                         throw new EmptyVariableException(array($this, 'actionName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  89                 } // END - if
  90
  91                 // Now, let us create the full name of the action class
  92                 $className = sprintf("%s%sAction",
  93                         $this->actionPrefix,
  94                         $this->convertToClassName($actionName)
  95                 );
  96
  97                 // Is this class already loaded?
  98                 if (class_exists($className)) {
  99                         // This class does exist. :-)
 100                         $isValid = true;
 101                 } // END - if
 102
 103                 // Debug output
 104                 //* DEBUG: */ $this->debugBacktrace();
 105
 106                 // Set action name
 107                 $this->setActionName($actionName);
 108
 109                 // Return the result
 110                 return $isValid;
 111         }
 112
 113         /**
 114          * "Loads" current action and instances it if not yet cached
 115          *
 116          * @return      $actionInstance                 A loaded action instance
 117          * @throws      InvalidActionException  Thrown if even the default
 118          *                                                                      action class is missing (bad!)
 119          */
 120         protected function loadAction () {
 121                 // Init action instance
 122                 $actionInstance = null;
 123
 124                 // Create action class name
 125                 $className = sprintf("Web%sAction",
 126                         $this->convertToClassName($this->getActionName())
 127                 );
 128
 129                 // Initiate the action
 130                 $actionInstance = ObjectFactory::createObjectByName($className, array($this));
 131
 132                 // Return the result
 133                 return $actionInstance;
 134         }
 135 }
 136
 137 // [EOF]
 138 ?>