3 * A action resolver for local (non-hubbed) actions
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class WebActionResolver extends BaseActionResolver implements ActionResolver {
26 * Last successfull resolved action
28 private $lastActionInstance = "";
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
39 // Set part description
40 $this->setObjectDescription("Resolver for local web actions");
42 // Create unique ID number
43 $this->generateUniqueId();
45 // Set prefix to "Web"
46 $this->setActionPrefix("Web");
50 * Creates an instance of a Web action resolver with a given default action
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
58 public final static function createWebActionResolver ($actionName, ManageableApplication $appInstance) {
59 // Create the new instance
60 $resolverInstance = new WebActionResolver();
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);
71 // Set the application instance
72 $resolverInstance->setApplicationInstance($appInstance);
74 // Return the prepared instance
75 return $resolverInstance;
79 * Returns an action instance for a given request class or null if
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
86 * @throws InvalidActionInstanceException Thrown if $actionInstance
87 * is an invalid instance
89 public function resolveActionByRequest (Requestable $requestInstance) {
92 $actionInstance = null;
94 // This goes fine so let's resolv the action
95 $actionName = $requestInstance->getRequestElement('action');
97 // Is the action empty? Then fall back to default action
98 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
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);
107 $actionInstance = $this->loadAction();
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);
116 $this->lastActionInstance = $actionInstance;
118 // Return the resolved action instance
119 return $actionInstance;
123 * Resolves the action by its direct name and returns an instance of its class
125 * @return $actionInstance An instance of the action class
126 * @throws InvalidActionException Thrown if $actionName is invalid
128 public function resolveAction () {
129 // Initiate the instance variable
130 $actionInstance = null;
133 $actionName = $this->getActionName();
135 // Is the action empty? Then fall back to default action
136 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
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);
145 $actionInstance = $this->loadAction();
147 // Return the instance
148 return $actionInstance;