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 - 2009 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          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Setter for action prefix
  48          *
  49          * @param       $actionPrefix   Last validated actionPrefix
  50          * @return      void
  51          */
  52         protected final function setActionPrefix ($actionPrefix) {
  53                 $this->actionPrefix = $actionPrefix;
  54         }
  55
  56         /**
  57          * Setter for action name
  58          *
  59          * @param       $actionName     Last validated action name
  60          * @return      void
  61          */
  62         protected final function setActionName ($actionName) {
  63                 $this->actionName = (string) $actionName;
  64         }
  65
  66         /**
  67          * Getter for action name
  68          *
  69          * @return      $actionName     Last validated action name
  70          */
  71         public final function getActionName () {
  72                 return $this->actionName;
  73         }
  74
  75         /**
  76          * Checks wether the given action is valid
  77          *
  78          * @param       $actionName     The default action we shall execute
  79          * @return      $isValid                Wether the given action is valid
  80          * @throws      EmptyVariableException  Thrown if given action is not set
  81          */
  82         public function isActionValid ($actionName) {
  83                 // By default nothing shall be valid
  84                 $isValid = false;
  85
  86                 // Is a action set?
  87                 if (empty($actionName)) {
  88                         // Then thrown an exception here
  89                         throw new EmptyVariableException(array($this, 'actionName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  90                 } // END - if
  91
  92                 // Create class name
  93                 $className = $this->actionPrefix . $this->convertToClassName($actionName) . 'Action';
  94
  95                 // Now, let us create the full name of the action class
  96                 $this->setClassName($className);
  97
  98                 // Is this class already loaded?
  99                 if (class_exists($this->getClassName())) {
 100                         // This class does exist. :-)
 101                         $isValid = true;
 102                 } // END - if
 103
 104                 // Set action name
 105                 $this->setActionName($actionName);
 106
 107                 // Return the result
 108                 return $isValid;
 109         }
 110
 111         /**
 112          * "Loads" current action and instances it if not yet cached
 113          *
 114          * @return      $actionInstance                 A loaded action instance
 115          */
 116         protected function loadAction () {
 117                 // Init action instance
 118                 $actionInstance = null;
 119
 120                 // Create action class name
 121                 $className = $this->actionPrefix . $this->convertToClassName($this->getActionName()) . 'Action';
 122
 123                 // ... and set it
 124                 $this->setClassName($className);
 125
 126                 // Initiate the action
 127                 $actionInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
 128
 129                 // Return the result
 130                 return $actionInstance;
 131         }
 132 }
 133
 134 // [EOF]
 135 ?>