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, 2009 Core Developer Team
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 prefix to "Web"
40 $this->setActionPrefix("Web");
44 * Creates an instance of a Web action resolver with a given default action
46 * @param $actionName The default action we shall execute
47 * @param $appInstance An instance of a manageable application helper class
48 * @return $resolverInstance The prepared action resolver instance
49 * @throws EmptyVariableException Thrown if default action is not set
50 * @throws InvalidActionException Thrown if default action is invalid
52 public final static function createWebActionResolver ($actionName, ManageableApplication $appInstance) {
53 // Create the new instance
54 $resolverInstance = new WebActionResolver();
56 // Is the variable $actionName set and the action is valid?
57 if (empty($actionName)) {
58 // Then thrown an exception here
59 throw new EmptyVariableException(array($resolverInstance, 'defaultAction'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
60 } elseif ($resolverInstance->isActionValid($actionName) === false) {
61 // Invalid action found
62 throw new InvalidActionException(array($resolverInstance, $actionName), self::EXCEPTION_INVALID_ACTION);
65 // Set the application instance
66 $resolverInstance->setApplicationInstance($appInstance);
68 // Return the prepared instance
69 return $resolverInstance;
73 * Returns an action instance for a given request class or null if
76 * @param $requestInstance An instance of a request class
77 * @return $actionInstance An instance of the resolved action
78 * @throws InvalidActionException Thrown if $actionName is
80 * @throws InvalidActionInstanceException Thrown if $actionInstance
81 * is an invalid instance
83 public function resolveActionByRequest (Requestable $requestInstance) {
86 $actionInstance = null;
88 // This goes fine so let's resolve the action
89 $actionName = $requestInstance->getRequestElement('action');
91 // Is the action empty? Then fall back to default action
92 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
94 // Check if action is valid
95 if ($this->isActionValid($actionName) === false) {
96 // This action is invalid!
97 throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
101 $actionInstance = $this->loadAction();
104 if ((!is_object($actionInstance)) || (!$actionInstance instanceof Actionable)) {
105 // This action has an invalid instance!
106 throw new InvalidActionInstanceException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
110 $this->lastActionInstance = $actionInstance;
112 // Return the resolved action instance
113 return $actionInstance;
117 * Resolves the action by its direct name and returns an instance of its class
119 * @return $actionInstance An instance of the action class
120 * @throws InvalidActionException Thrown if $actionName is invalid
122 public function resolveAction () {
123 // Initiate the instance variable
124 $actionInstance = null;
127 $actionName = $this->getActionName();
129 // Is the action empty? Then fall back to default action
130 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
132 // Check if action is valid
133 if ($this->isActionValid($actionName) === false) {
134 // This action is invalid!
135 throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
139 $actionInstance = $this->loadAction();
141 // Return the instance
142 return $actionInstance;