inc/classes/main/resolver/action/web/class_WebActionResolver.php

   1 <?php
   2 /**
   3  * A action resolver for local (non-hubbed) actions
   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 WebActionResolver extends BaseActionResolver implements ActionResolver {
  25         /**
  26          * Last successfull resolved action
  27          */
  28         private $lastActionInstance = "";
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set part description
  40                 $this->setObjectDescription("Resolver for local web actions");
  41
  42                 // Create unique ID number
  43                 $this->generateUniqueId();
  44
  45                 // Set prefix to "Web"
  46                 $this->setActionPrefix("Web");
  47         }
  48
  49         /**
  50          * Creates an instance of a Web action resolver with a given default action
  51          *
  52          * @param       $actionName                             The default action we shall execute
  53          * @param       $appInstance                    An instance of a manageable application helper class
  54          * @return      $resolverInstance               The prepared action resolver instance
  55          * @throws      EmptyVariableException  Thrown if the default action is not set
  56          * @throws      InvalidActionException  Thrown if the default action is invalid
  57          */
  58         public final static function createWebActionResolver ($actionName, ManageableApplication $appInstance) {
  59                 // Create the new instance
  60                 $resolverInstance = new WebActionResolver();
  61
  62                 // Is the variable $actionName set and the action is valid?
  63                 if (empty($actionName)) {
  64                         // Then thrown an exception here
  65                         throw new EmptyVariableException(array($resolverInstance, 'defaultAction'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  66                 } elseif (!$resolverInstance->isActionValid($actionName)) {
  67                         // Invalid action found
  68                         throw new InvalidActionException(array($resolverInstance, $actionName), self::EXCEPTION_INVALID_ACTION);
  69                 }
  70
  71                 // Set the application instance
  72                 $resolverInstance->setApplicationInstance($appInstance);
  73
  74                 // Return the prepared instance
  75                 return $resolverInstance;
  76         }
  77
  78         /**
  79          * Returns an action instance for a given request class or null if
  80          * it was not found
  81          *
  82          * @param       $requestInstance        An instance of a request class
  83          * @return      $actionInstance An instance of the resolved action
  84          * @throws      InvalidActionException                          Thrown if $actionName is
  85          *                                                                                              invalid
  86          * @throws      InvalidActionInstanceException          Thrown if $actionInstance
  87          *                                                                                              is an invalid instance
  88          */
  89         public function resolveActionByRequest (Requestable $requestInstance) {
  90                 // Init variables
  91                 $actionName = "";
  92                 $actionInstance = null;
  93
  94                 // This goes fine so let's resolv the action
  95                 $actionName = $requestInstance->getRequestElement('action');
  96
  97                 // Is the action empty? Then fall back to default action
  98                 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
  99
 100                 // Check if the action is valid
 101                 if (!$this->isActionValid($actionName)) {
 102                         // This action is invalid!
 103                         throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
 104                 } // END - if
 105
 106                 // Get the action
 107                 $actionInstance = $this->loadAction();
 108
 109                 // And validate it
 110                 if ((!is_object($actionInstance)) || (!$actionInstance instanceof Actionable)) {
 111                         // This action has an invalid instance!
 112                         throw new InvalidActionInstanceException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
 113                 } // END - if
 114
 115                 // Set last action
 116                 $this->lastActionInstance = $actionInstance;
 117
 118                 // Return the resolved action instance
 119                 return $actionInstance;
 120         }
 121
 122         /**
 123          * Resolves the action by its direct name and returns an instance of its class
 124          *
 125          * @return      $actionInstance         An instance of the action class
 126          * @throws      InvalidActionException  Thrown if $actionName is invalid
 127          */
 128         public function resolveAction () {
 129                 // Initiate the instance variable
 130                 $actionInstance = null;
 131
 132                 // Get action name
 133                 $actionName = $this->getActionName();
 134
 135                 // Is the action empty? Then fall back to default action
 136                 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
 137
 138                 // Check if the action is valid
 139                 if (!$this->isActionValid($actionName)) {
 140                         // This action is invalid!
 141                         throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
 142                 }
 143
 144                 // Get the action
 145                 $actionInstance = $this->loadAction();
 146
 147                 // Return the instance
 148                 return $actionInstance;
 149         }
 150 }
 151
 152 // [EOF]
 153 ?>