3 namespace Org\Mxchange\CoreFramework\Resolver\Action;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Request\Requestable;
10 use \InvalidArgumentException;
13 * A action resolver for local (non-hubbed) actions
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
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.
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.
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/>.
34 class HtmlActionResolver extends BaseActionResolver implements ActionResolver {
36 * Last successfull resolved action
38 private $lastActionInstance = NULL;
41 * Protected constructor
45 protected function __construct () {
46 // Call parent constructor
47 parent::__construct(__CLASS__);
49 // Set prefix to 'html'
50 $this->setClassPrefix('html');
54 * Creates an instance of a Html action resolver with a given default action
56 * @param $actionName The default action we shall execute
57 * @return $resolverInstance The prepared action resolver instance
58 * @throws InvalidArgumentException Thrown if default action is not set
59 * @throws InvalidActionException Thrown if default action is invalid
61 public static final function createHtmlActionResolver ($actionName) {
62 // Create the new instance
63 $resolverInstance = new HtmlActionResolver();
65 // Is the variable $actionName set and the action is valid?
66 if (empty($actionName)) {
67 // Then thrown an exception here
68 throw new InvalidArgumentException('Parameter "actionName" is empty');
69 } elseif ($resolverInstance->isActionValid($actionName) === false) {
70 // Invalid action found
71 throw new InvalidActionException(array($resolverInstance, $actionName), self::EXCEPTION_INVALID_ACTION);
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 Requestable 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 resolve the action
95 $actionName = $requestInstance->getRequestElement('action');
97 // Is the action empty? Then fall back to default action
98 if (empty($actionName)) {
99 $actionName = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('default_action');
102 // Check if action is valid
103 if ($this->isActionValid($actionName) === false) {
104 // This action is invalid!
105 throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
109 $actionInstance = $this->loadAction();
112 if ((!is_object($actionInstance)) || (!$actionInstance instanceof Actionable)) {
113 // This action has an invalid instance!
114 throw new InvalidActionInstanceException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
118 $this->setResolvedInstance($actionInstance);
120 // Return the resolved action instance
121 return $actionInstance;
125 * Resolves the action by its direct name and returns an instance of its class
127 * @return $actionInstance An instance of the action class
128 * @throws InvalidActionException Thrown if $actionName is invalid
130 public function resolveAction () {
131 // Initiate the instance variable
132 $actionInstance = NULL;
135 $actionName = $this->getActionName();
137 // Is the action empty? Then fall back to default action
138 if (empty($actionName)) {
139 $actionName = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('default_action');
142 // Check if action is valid
143 if ($this->isActionValid($actionName) === false) {
144 // This action is invalid!
145 throw new InvalidActionException(array($this, $actionName), self::EXCEPTION_INVALID_ACTION);
149 $actionInstance = $this->loadAction();
151 // Return the instance
152 return $actionInstance;