All empty double-quoted strings replaced with single-quotes
[core.git] / 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 - 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 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 prefix to "Web"
40                 $this->setActionPrefix("Web");
41         }
42
43         /**
44          * Creates an instance of a Web action resolver with a given default action
45          *
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
51          */
52         public final static function createWebActionResolver ($actionName, ManageableApplication $appInstance) {
53                 // Create the new instance
54                 $resolverInstance = new WebActionResolver();
55
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);
63                 }
64
65                 // Set the application instance
66                 $resolverInstance->setApplicationInstance($appInstance);
67
68                 // Return the prepared instance
69                 return $resolverInstance;
70         }
71
72         /**
73          * Returns an action instance for a given request class or null if
74          * it was not found
75          *
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
79          *                                                                                              invalid
80          * @throws      InvalidActionInstanceException          Thrown if $actionInstance
81          *                                                                                              is an invalid instance
82          */
83         public function resolveActionByRequest (Requestable $requestInstance) {
84                 // Init variables
85                 $actionName = '';
86                 $actionInstance = null;
87
88                 // This goes fine so let's resolv the action
89                 $actionName = $requestInstance->getRequestElement('action');
90
91                 // Is the action empty? Then fall back to default action
92                 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
93
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);
98                 } // END - if
99
100                 // Get the action
101                 $actionInstance = $this->loadAction();
102
103                 // And validate it
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);
107                 } // END - if
108
109                 // Set last action
110                 $this->lastActionInstance = $actionInstance;
111
112                 // Return the resolved action instance
113                 return $actionInstance;
114         }
115
116         /**
117          * Resolves the action by its direct name and returns an instance of its class
118          *
119          * @return      $actionInstance         An instance of the action class
120          * @throws      InvalidActionException  Thrown if $actionName is invalid
121          */
122         public function resolveAction () {
123                 // Initiate the instance variable
124                 $actionInstance = null;
125
126                 // Get action name
127                 $actionName = $this->getActionName();
128
129                 // Is the action empty? Then fall back to default action
130                 if (empty($actionName)) $actionName = $this->getConfigInstance()->readConfig('default_action');
131
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);
136                 }
137
138                 // Get the action
139                 $actionInstance = $this->loadAction();
140
141                 // Return the instance
142                 return $actionInstance;
143         }
144 }
145
146 // [EOF]
147 ?>