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