]> git.mxchange.org Git - core.git/blob - inc/classes/main/resolver/action/web/class_WebActionResolver.php
Copyright year updated, converted double->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@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 = NULL;
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->setClassPrefix('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       $applicationInstance    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 static final function createWebActionResolver ($actionName, ManageableApplication $applicationInstance) {
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($applicationInstance);
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 resolve the action
89                 $actionName = $requestInstance->getRequestElement('action');
90
91                 // Is the action empty? Then fall back to default action
92                 if (empty($actionName)) {
93                         $actionName = $this->getConfigInstance()->getConfigEntry('default_action');
94                 } // END - if
95
96                 // Check if action is valid
97                 if ($this->isActionValid($actionName) === FALSE) {
98                         // This action is invalid!
99                         throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
100                 } // END - if
101
102                 // Get the action
103                 $actionInstance = $this->loadAction();
104
105                 // And validate it
106                 if ((!is_object($actionInstance)) || (!$actionInstance instanceof Actionable)) {
107                         // This action has an invalid instance!
108                         throw new InvalidActionInstanceException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
109                 } // END - if
110
111                 // Set last action
112                 $this->setResolvedInstance($actionInstance);
113
114                 // Return the resolved action instance
115                 return $actionInstance;
116         }
117
118         /**
119          * Resolves the action by its direct name and returns an instance of its class
120          *
121          * @return      $actionInstance         An instance of the action class
122          * @throws      InvalidActionException  Thrown if $actionName is invalid
123          */
124         public function resolveAction () {
125                 // Initiate the instance variable
126                 $actionInstance = NULL;
127
128                 // Get action name
129                 $actionName = $this->getActionName();
130
131                 // Is the action empty? Then fall back to default action
132                 if (empty($actionName)) {
133                         $actionName = $this->getConfigInstance()->getConfigEntry('default_action');
134                 } // END - if
135
136                 // Check if action is valid
137                 if ($this->isActionValid($actionName) === FALSE) {
138                         // This action is invalid!
139                         throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
140                 } // END - if
141
142                 // Get the action
143                 $actionInstance = $this->loadAction();
144
145                 // Return the instance
146                 return $actionInstance;
147         }
148 }
149
150 // [EOF]
151 ?>