inc/main/classes/resolver/action/html/class_HtmlActionResolver.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Resolver\Action;
   4
   5 // Import framework stuff
   6 use CoreFramework\Manager\ManageableApplication;
   7
   8 /**
   9  * A action resolver for local (non-hubbed) actions
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class HtmlActionResolver extends BaseActionResolver implements ActionResolver {
  31         /**
  32          * Last successfull resolved action
  33          */
  34         private $lastActionInstance = NULL;
  35
  36         /**
  37          * Protected constructor
  38          *
  39          * @return      void
  40          */
  41         protected function __construct () {
  42                 // Call parent constructor
  43                 parent::__construct(__CLASS__);
  44
  45                 // Set prefix to 'html'
  46                 $this->setClassPrefix('html');
  47         }
  48
  49         /**
  50          * Creates an instance of a Html action resolver with a given default action
  51          *
  52          * @param       $actionName                             The default action we shall execute
  53          * @param       $applicationInstance    An instance of a manageable application helper class
  54          * @return      $resolverInstance               The prepared action resolver instance
  55          * @throws      EmptyVariableException  Thrown if default action is not set
  56          * @throws      InvalidActionException  Thrown if default action is invalid
  57          */
  58         public static final function createHtmlActionResolver ($actionName, ManageableApplication $applicationInstance) {
  59                 // Create the new instance
  60                 $resolverInstance = new HtmlActionResolver();
  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) === FALSE) {
  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($applicationInstance);
  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 resolve the action
  95                 $actionName = $requestInstance->getRequestElement('action');
  96
  97                 // Is the action empty? Then fall back to default action
  98                 if (empty($actionName)) {
  99                         $actionName = $this->getConfigInstance()->getConfigEntry('default_action');
 100                 } // END - if
 101
 102                 // Check if action is valid
 103                 if ($this->isActionValid($actionName) === FALSE) {
 104                         // This action is invalid!
 105                         throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
 106                 } // END - if
 107
 108                 // Get the action
 109                 $actionInstance = $this->loadAction();
 110
 111                 // And validate it
 112                 if ((!is_object($actionInstance)) || (!$actionInstance instanceof Actionable)) {
 113                         // This action has an invalid instance!
 114                         throw new InvalidActionInstanceException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
 115                 } // END - if
 116
 117                 // Set last action
 118                 $this->setResolvedInstance($actionInstance);
 119
 120                 // Return the resolved action instance
 121                 return $actionInstance;
 122         }
 123
 124         /**
 125          * Resolves the action by its direct name and returns an instance of its class
 126          *
 127          * @return      $actionInstance         An instance of the action class
 128          * @throws      InvalidActionException  Thrown if $actionName is invalid
 129          */
 130         public function resolveAction () {
 131                 // Initiate the instance variable
 132                 $actionInstance = NULL;
 133
 134                 // Get action name
 135                 $actionName = $this->getActionName();
 136
 137                 // Is the action empty? Then fall back to default action
 138                 if (empty($actionName)) {
 139                         $actionName = $this->getConfigInstance()->getConfigEntry('default_action');
 140                 } // END - if
 141
 142                 // Check if action is valid
 143                 if ($this->isActionValid($actionName) === FALSE) {
 144                         // This action is invalid!
 145                         throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
 146                 } // END - if
 147
 148                 // Get the action
 149                 $actionInstance = $this->loadAction();
 150
 151                 // Return the instance
 152                 return $actionInstance;
 153         }
 154
 155 }