3 * A generic helper class with generic methods
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class BaseHelper extends BaseFrameworkSystem {
26 * Instance to the class which provides field values
28 private $valueInstance = null;
31 * Rendered content created by the helper class
33 private $content = "";
38 private $groups = array();
41 * Array with sub group
43 private $subGroups = array();
46 * Previously opened group
48 private $previousGroupId = "";
51 * Previously opened sub group
53 private $previousSubGroupId = "";
56 * Total counter for groups and sub groups
58 private $totalCounter = 0;
60 // Exception constants
61 const EXCEPTION_XML_PARSER_ERROR = 0x1e0;
62 const EXCEPTION_XML_NODE_UNKNOWN = 0x1e1;
63 const EXCEPTION_XML_NODE_MISMATCH = 0x1e2;
64 const EXCEPTION_GROUP_NOT_OPENED = 0x1e3;
65 const EXCEPTION_GROUP_ALREADY_FOUND = 0x1e4;
66 const EXCEPTION_SUB_GROUP_ALREADY_FOUND = 0x1e5;
67 const EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED = 0x1e6;
68 const EXCEPTION_NO_PREVIOUS_GROUP_OPENED = 0x1e7;
71 * Protected constructor
73 * @param $className Real name of the class
76 protected function __construct ($className) {
77 // Call parent constructor
78 parent::__construct($className);
81 $this->removeNumberFormaters();
82 $this->removeSystemArray();
86 * Adds content directly
88 * @param $newContent New content to add
91 protected final function addContent ($newContent) {
92 $this->content .= (string) trim($newContent)."\n";
96 * Add header content to the helper
98 * @param $content Content to to the base
101 protected function addHeaderContent ($content) {
102 // Add the header content
103 $this->groups['header']['content'] = (string) trim($content);
107 * Add footer content to the helper
109 * @param $content Content to to the base
112 protected function addFooterContent ($content) {
113 // Add the footer content
114 $this->groups['footer']['content'] = (string) trim($content);
118 * Adds content to the previously opened group or sub group. If a sub group
119 * was found it will be taken. If no group/sub group is opened at the moment
120 * the code will be passed to addContent().
122 * @param $newContent New content to add
125 protected final function addContentToPreviousGroup ($newContent) {
126 // Check for sub/group
127 if ($this->ifSubGroupOpenedPreviously()) {
129 $subGroupId = $this->getPreviousSubGroupId();
132 $this->subGroups[$subGroupId]['content'] .= $newContent;
133 } elseif ($this->ifGroupOpenedPreviously()) {
135 $groupId = $this->getPreviousGroupId();
138 $this->groups[$groupId]['content'] .= $newContent;
141 $this->addContent($newContent);
148 * @return $content The rendered content by this helper
150 protected final function getContent () {
151 return $this->content;
155 * Assigns a field from the value instance with a template variable
157 * @param $fieldName Name of the field to assign
160 public function assignField ($fieldName) {
161 // Get the value from value instance
162 $fieldValue = $this->getValueField($fieldName);
164 // Assign it with a template variable
165 $this->getTemplateInstance()->assignVariable('block_' . $fieldName, $fieldValue);
169 * Assigns a field from the value instance with a template variable but
170 * parses its content through a given filter method of the value instance
172 * @param $fieldName Name of the field to assign
173 * @param $filterMethod Method name to call of the value instance
175 * @todo Rewrite this method using a helper class for filtering data
177 public function assignFieldWithFilter ($fieldName, $filterMethod) {
179 $fieldValue = $this->getValueField($fieldName);
181 // Now filter it through the value through the filter method
182 $filteredValue = call_user_func_array(array($this, 'doFilter' . $this->convertToClassName($filterMethod)), array($fieldValue));
184 // Assign it with a template variable
185 $this->getTemplateInstance()->assignVariable('block_' . $fieldName, $filteredValue);
189 * Pre-fetches field default values from the given registry key instance into this class
191 * @param $registryKey Registry key which holds an object with values
192 * @param $extraKey Extra value instance key used if registryKey is null
194 * @throws NullPointerException If recovery of requested value instance failed
196 public function prefetchValueInstance ($registryKey, $extraKey = null) {
197 // Get the required instance
198 $this->valueInstance = Registry::getRegistry()->getInstance($registryKey);
200 // Is the value instance valid?
201 if (is_null($this->valueInstance)) {
202 // Try to create it "from scratch", by first init extra instance
203 $extraInstance = null;
205 // Shall we get an extra instance?
206 if (!is_null($extraKey)) {
207 // Get the extra instance.
208 $extraInstance = Registry::getRegistry()->getInstance($extraKey);
211 // Get the requested instance
213 $this->valueInstance = ObjectFactory::createObjectByConfiguredName($registryKey . '_class', array($extraInstance));
215 } catch (FrameworkException $e) {
216 // Okay, nothing found so throw a null pointer exception here
217 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
223 * Opens a helper group with given group id and content or throws an
224 * exception if that group is already found regardless if it is open or
227 * @param $groupId Group id to open
228 * @param $content Initial content to add to the group
230 * @throws HelperGroupAlreadyCreatedException If the group was already created before
232 protected function openGroupByIdContent ($groupId, $content) {
233 //* DEBUG: */ echo "OPEN:groupId={$groupId}<br />\n";
234 // Is the group already there?
235 if (isset($this->groups[$groupId])) {
236 // Then throw an exception here
237 throw new HelperGroupAlreadyCreatedException(array($this, $groupId), self::EXCEPTION_GROUP_ALREADY_FOUND);
241 $this->totalCounter++;
243 // Add the group to the stack
244 $this->groups[$this->totalCounter] = $groupId;
245 $this->groups[$groupId]['opened'] = true;
246 $this->groups[$groupId]['content'] = $content."\n";
248 // Mark this group as previously opened
249 $this->setPreviousGroupId($groupId);
253 * Closes the previously opened group by added given content to it or
254 * throws an exception if no previous group was opened
256 * @param $content Content for previously opened grouop
258 * @throws HelperNoPreviousOpenedGroupException If no previously opened group was found
260 public function closePreviousGroupByContent ($content) {
261 // Check if any group was opened before
262 if (!$this->ifGroupOpenedPreviously()) {
263 // Then throw an exception
264 throw new HelperNoPreviousOpenedGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
267 // Get previous group
268 $groupId = $this->getPreviousGroupId();
270 // Add content to it and mark it as closed
271 $this->groups[$groupId]['content'] .= $content."\n";
272 $this->groups[$groupId]['opened'] = false;
274 // Mark previous group as closed
275 $this->setPreviousGroupId("");
276 //* DEBUG: */ echo "CLOSE:groupId={$groupId}<br />\n";
280 * Opens a helper sub group with given group id and content or throws an
281 * exception if that sub group is already found regardless if it is open or
284 * @param $subGroupId Sub group id to open
285 * @param $content Initial content to add to the sub group
287 * @throws HelperSubGroupAlreadyCreatedException If the sub group was already created before
289 protected function openSubGroupByIdContent ($subGroupId, $content) {
290 //* DEBUG: */ echo "OPEN:subGroupId={$subGroupId},content=".htmlentities($content)."<br />\n";
291 // Is the group already there?
292 if (isset($this->subGroups[$subGroupId])) {
293 // Then throw an exception here
294 throw new HelperSubGroupAlreadyCreatedException(array($this, $subGroupId), self::EXCEPTION_SUB_GROUP_ALREADY_FOUND);
298 $this->totalCounter++;
300 // Add the group to the stack
301 $this->subGroups[$this->totalCounter] = $subGroupId;
302 $this->subGroups[$subGroupId]['opened'] = true;
303 $this->subGroups[$subGroupId]['content'] = $content."\n";
305 // Mark this group as previously opened
306 $this->setPreviousSubGroupId($subGroupId);
310 * Closes the previously opened sub group by added given content to it or
311 * throws an exception if no previous sub group was opened
313 * @param $content Content for previously opened sub grouop
315 * @throws HelperNoPreviousOpenedSubGroupException If no previously opened sub group was found
317 public function closePreviousSubGroupByContent ($content) {
318 // Check if any sub group was opened before
319 if (!$this->ifSubGroupOpenedPreviously()) {
320 // Then throw an exception
321 throw new HelperNoPreviousOpenedSubGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
324 // Get previous sub group
325 $subGroupId = $this->getPreviousSubGroupId();
327 // Add content to it and mark it as closed
328 $this->subGroups[$subGroupId]['content'] .= $content."\n";
329 $this->subGroups[$subGroupId]['opened'] = false;
331 // Mark previous sub group as closed
332 $this->setPreviousSubGroupId("");
333 //* DEBUG: */ echo "CLOSE:subGroupId={$subGroupId}<br />\n";
337 * Renders all group and sub group in their order
339 * @return $content Rendered HTML content
341 public function renderContent () {
342 // Initialize content
345 // Is header content there?
346 if (isset($this->groups['header'])) {
348 $content .= $this->groups['header']['content']."\n";
352 $content .= $this->getContent();
354 // Now "walk" through all groups and sub-groups
355 for ($idx = 1; $idx <= $this->totalCounter; $idx++) {
356 // Is this a group and is it closed?
357 if ((isset($this->groups[$idx])) && ($this->groups[$this->groups[$idx]]['opened'] === false)) {
358 // Then add it's content
359 $groupContent = $this->groups[$this->groups[$idx]]['content'];
360 //* DEBUG: */ echo "group={$this->groups[$idx]},content=<pre>".htmlentities($groupContent)."</pre><br />\n";
361 $content .= $groupContent;
362 } elseif ((isset($this->subGroups[$idx])) && ($this->subGroups[$this->subGroups[$idx]]['opened'] === false)) {
363 // Then add it's content
364 $subGroupContent = $this->subGroups[$this->subGroups[$idx]]['content'];
365 //* DEBUG: */ echo "subgroup={$this->subGroups[$idx]},content=<pre>".htmlentities($subGroupContent)."</pre><br />\n";
366 $content .= $subGroupContent;
368 // Something went wrong
369 $this->debugInstance();
374 // Is footer content there?
375 if (isset($this->groups['footer'])) {
377 $content .= $this->groups['footer']['content']."\n";
381 //* DEBUG: */ echo "content=<pre>".htmlentities($content)."</pre> (".strlen($content).")<br />\n";
386 * Checks wether the specified group is opened
388 * @param $groupId Id of group to check
389 * @return $isOpened Wether the specified group is open
391 protected function ifGroupIsOpened ($groupId) {
392 // Is the group open?
393 $isOpened = ((isset($this->groups[$groupId])) && ($this->groups[$groupId]['opened'] === true));
400 * Getter for direct field values
402 * @param $fieldName Name of the field we shall fetch
403 * @return $fieldValue Value from field
405 public function getValueField ($fieldName) {
406 // Get the field value
407 $fieldValue = call_user_func_array(array($this->valueInstance, 'getField'), array($fieldName));
414 * Getter for value instance
416 * @return $valueInstance Instance of the class holding our values
418 public final function getValueInstance () {
419 return $this->valueInstance;
423 * Check wether a group was opened previously
425 * @return $groupOpened Wether any group was opened before
427 protected final function ifGroupOpenedPreviously () {
428 $groupOpened = (!empty($this->previousGroupId));
433 * Check wether a group was opened previously
435 * @return $subGroupOpened Wether any group was opened before
437 protected final function ifSubGroupOpenedPreviously () {
438 $subGroupOpened = (!empty($this->previousSubGroupId));
439 return $subGroupOpened;
443 * Getter for previous group id
445 * @return $previousGroupId Id of previously opened group
447 protected final function getPreviousGroupId () {
448 return $this->previousGroupId;
452 * Setter for previous group id
454 * @param $previousGroupId Id of previously opened group
457 protected final function setPreviousGroupId ($previousGroupId) {
458 $this->previousGroupId = (string) $previousGroupId;
462 * Getter for previous sub group id
464 * @return $previousSubGroupId Id of previously opened sub group
466 protected final function getPreviousSubGroupId () {
467 return $this->previousSubGroupId;
471 * Setter for previous sub group id
473 * @param $previousSubGroupId Id of previously opened sub group
476 protected final function setPreviousSubGroupId ($previousSubGroupId) {
477 $this->previousSubGroupId = (string) $previousSubGroupId;