]> git.mxchange.org Git - core.git/blob - inc/classes/main/resolver/action/class_BaseActionResolver.php
Copyright year updated, converted double->single quotes
[core.git] / inc / classes / main / resolver / action / class_BaseActionResolver.php
1 <?php
2 /**
3  * A generic action resolver class
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 BaseActionResolver extends BaseResolver {
25         /**
26          * Validated action name
27          */
28         private $actionName = '';
29
30         /**
31          * Protected constructor
32          *
33          * @param       $className      Name of the class
34          * @return      void
35          */
36         protected function __construct ($className) {
37                 // Call parent constructor
38                 parent::__construct($className);
39         }
40
41         /**
42          * Setter for action name
43          *
44          * @param       $actionName     Last validated action name
45          * @return      void
46          */
47         protected final function setActionName ($actionName) {
48                 $this->actionName = (string) $actionName;
49         }
50
51         /**
52          * Getter for action name
53          *
54          * @return      $actionName     Last validated action name
55          */
56         public final function getActionName () {
57                 return $this->actionName;
58         }
59
60         /**
61          * Checks whether the given action is valid
62          *
63          * @param       $actionName     The default action we shall execute
64          * @return      $isValid                Whether the given action is valid
65          * @throws      EmptyVariableException  Thrown if given action is not set
66          */
67         public function isActionValid ($actionName) {
68                 // By default nothing shall be valid
69                 $isValid = FALSE;
70
71                 // Is a action set?
72                 if (empty($actionName)) {
73                         // Then thrown an exception here
74                         throw new EmptyVariableException(array($this, 'actionName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
75                 } // END - if
76
77                 // Create class name
78                 $className = $this->getClassPrefix() . $this->convertToClassName($actionName) . 'Action';
79
80                 // Now, let us create the full name of the action class
81                 $this->setClassName($className);
82
83                 // Is this class already loaded?
84                 if (class_exists($this->getClassName())) {
85                         // This class does exist. :-)
86                         $isValid = TRUE;
87                 } // END - if
88
89                 // Set action name
90                 $this->setActionName($actionName);
91
92                 // Return the result
93                 return $isValid;
94         }
95
96         /**
97          * "Loads" current action and instances it if not yet cached
98          *
99          * @return      $actionInstance                 A loaded action instance
100          */
101         protected function loadAction () {
102                 // Init action instance
103                 $actionInstance = NULL;
104
105                 // Create action class name
106                 $className = $this->getClassPrefix() . $this->convertToClassName($this->getActionName()) . 'Action';
107
108                 // ... and set it
109                 $this->setClassName($className);
110
111                 // Initiate the action
112                 $actionInstance = ObjectFactory::createObjectByName($this->getClassName(), array($this));
113
114                 // Return the result
115                 return $actionInstance;
116         }
117 }
118
119 // [EOF]
120 ?>