3 namespace CoreFramework\Resolver\Action;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Resolver\BaseResolver;
10 * A generic action resolver class
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 class BaseActionResolver extends BaseResolver {
33 * Validated action name
35 private $actionName = '';
38 * Protected constructor
40 * @param $className Name of the class
43 protected function __construct ($className) {
44 // Call parent constructor
45 parent::__construct($className);
49 * Setter for action name
51 * @param $actionName Last validated action name
54 protected final function setActionName ($actionName) {
55 $this->actionName = (string) $actionName;
59 * Getter for action name
61 * @return $actionName Last validated action name
63 public final function getActionName () {
64 return $this->actionName;
68 * Checks whether the given action is valid
70 * @param $actionName The default action we shall execute
71 * @return $isValid Whether the given action is valid
72 * @throws EmptyVariableException Thrown if given action is not set
74 public function isActionValid ($actionName) {
75 // By default nothing shall be valid
79 if (empty($actionName)) {
80 // Then thrown an exception here
81 throw new EmptyVariableException(array($this, 'actionName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
85 $className = $this->getCapitalizedClassPrefix() . self::convertToClassName($actionName) . 'Action';
87 // Now, let us create the full name of the action class
88 $this->setClassName($className);
90 // Is this class already loaded?
91 if (class_exists($this->getClassName())) {
92 // This class does exist. :-)
97 $this->setActionName($actionName);
104 * "Loads" current action and instances it if not yet cached
106 * @return $actionInstance A loaded action instance
108 protected function loadAction () {
109 // Init action instance
110 $actionInstance = NULL;
112 // Create action class name
113 $className = $this->getCapitalizedClassPrefix() . self::convertToClassName($this->getActionName()) . 'Action';
116 $this->setClassName($className);
118 // Initiate the action
119 $actionInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
122 return $actionInstance;