Fixed
[core.git] / inc / classes / main / resolver / controller / class_BaseControllerResolver.php
1 <?php
2 /**
3  * A generic controller resolver class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 BaseControllerResolver extends BaseResolver {
25         /**
26          * Prefix for local, remote or other resolver
27          */
28         private $controllerPrefix = '';
29
30         /**
31          * Validated controller name
32          */
33         private $controllerName = '';
34
35         /**
36          * Protected constructor
37          *
38          * @param       $className      Name of the real class
39          * @return      void
40          */
41         protected function __construct ($className) {
42                 // Call parent constructor
43                 parent::__construct($className);
44         }
45
46         /**
47          * Setter for controller prefix
48          *
49          * @param       $controllerPrefix       Last validated controllerPrefix
50          * @return      void
51          */
52         protected final function setControllerPrefix ($controllerPrefix) {
53                 $this->controllerPrefix = $controllerPrefix;
54         }
55
56         /**
57          * Setter for controller name
58          *
59          * @param       $controllerName         Last validated controller name
60          * @return      void
61          */
62         protected final function setControllerName ($controllerName) {
63                 $this->controllerName = $controllerName;
64         }
65
66         /**
67          * Getter for controller name
68          *
69          * @return      $controllerName Last validated controller name
70          */
71         public final function getControllerName () {
72                 return $this->controllerName;
73         }
74
75         /**
76          * "Loads" a given controller and instances it if not yet cached. If the
77          * controller was not found one of the default controllers will be used
78          * depending on wether news shall be displayed.
79          *
80          * @param       $controllerName                 A controller name we shall look for
81          * @return      $controllerInstance             A loaded controller instance
82          * @throws      InvalidControllerException      Thrown if even the requested
83          *                                                                              controller class is missing (bad!)
84          */
85         protected function loadController ($controllerName) {
86                 // Cache default command
87                 $defaultController = $this->getConfigInstance()->readConfig('default_' . strtolower($this->getControllerPrefix()) . '_command');
88
89                 // Init controller instance
90                 $controllerInstance = null;
91
92                 // Default controller
93                 $this->setClassName($this->getControllerPrefix() . 'DefaultNewsController');
94
95                 // Generate the class name
96                 //* DEBUG: */ echo __METHOD__.": Controller=".$controllerName;
97                 if ($controllerName != $defaultController) {
98                         // Create controller class name
99                         $className = $this->getControllerPrefix() . '' . $this->convertToClassName($controllerName) . 'Controller';
100
101                         // ... and set it
102                         $this->setClassName($className);
103                 } else {
104                         // No news at main command or non-news command
105                         $this->setClassName($this->getControllerPrefix() . 'DefaultNewsController');
106                 }
107                 //* DEBUG: */ echo ", controller=".$this->getClassName()."<br />\n";
108
109                 // Is this class loaded?
110                 if (!class_exists($this->getClassName())) {
111                         // Throw an exception here
112                         throw new InvalidControllerException(array($this, $controllerName), self::EXCEPTION_INVALID_CONTROLLER);
113                 } // END - if
114
115                 // Set default resolver config name
116                 $resolverConfigEntry = '';
117
118                 // Try to read a config entry for our resolver including controller name... ;-)
119                 try {
120                         // Create the resolver name
121                         $resolverConfigEntry = sprintf("%s_cmd_%s_resolver_class", strtolower($this->getControllerPrefix()), strtolower($controllerName));
122
123                         // Get the config, this will throw an exception if there is no special command resolver
124                         $resolverClass = $this->getConfigInstance()->readConfig($resolverConfigEntry);
125                 } catch (ConfigEntryNotFoundException $e) {
126                         // Use default resolver entry
127                         // @TODO Maybe we need to log this?
128                         $resolverConfigEntry = $this->getControllerPrefix() . '_cmd_resolver_class';
129                 }
130
131                 // Initiate the resolver and controller
132                 $resolverInstance = ObjectFactory::createObjectByConfiguredName(
133                         $resolverConfigEntry,
134                         array(
135                                 $controllerName,
136                                 $this->getApplicationInstance()
137                         )
138                 );
139                 $controllerInstance = ObjectFactory::createObjectByName(
140                         $this->getClassName(),
141                         array($resolverInstance)
142                 );
143
144                 // Return the result
145                 return $controllerInstance;
146         }
147
148         /**
149          * Checks wether the given controller is valid
150          *
151          * @param       $controllerName         The default controller we shall execute
152          * @return      $isValid                        Wether the given controller is valid
153          * @throws      EmptyVariableException          Thrown if given controller is not set
154          * @throws      DefaultControllerException      Thrown if default controller was not found
155          */
156         public function isControllerValid ($controllerName) {
157                 // By default nothing shall be valid
158                 $isValid = false;
159
160                 // Is a controller set?
161                 if (empty($controllerName)) {
162                         // Then thrown an exception here
163                         throw new EmptyVariableException(array($this, 'controllerName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
164                 } // END - if
165
166                 // Create class name
167                 $className = $this->controllerPrefix . $this->convertToClassName($controllerName) . 'Controller';
168
169                 // Now, let us create the full name of the controller class
170                 $this->setClassName($className);
171
172                 // Try it hard to get an controller
173                 while ($isValid === false) {
174                         // Is this class already loaded?
175                         if (class_exists($this->getClassName())) {
176                                 // This class does exist. :-)
177                                 $isValid = true;
178                         } elseif ($this->getClassName() != $this->controllerPrefix.'DefaultNewsController') {
179                                 // Set default controller
180                                 $this->setClassName($this->controllerPrefix . 'DefaultNewsController');
181                         } else {
182                                 // All is tried, give it up here
183                                 throw new DefaultControllerException($this, self::EXCEPTION_DEFAULT_CONTROLLER_GONE);
184                         }
185                 } // END - while
186
187                 // Return the result
188                 return $isValid;
189         }
190 }
191
192 // [EOF]
193 ?>