/**
* A generic helper class with generic methods
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* @return void
*/
protected final function addContent ($newContent) {
- $this->content .= (string) trim($newContent) . chr(10);
+ $this->content .= (string) trim($newContent) . PHP_EOL;
}
/**
return $this->content;
}
+ /**
+ * Public setter for extra instance
+ *
+ * @param $extraInstance An extra instance of FrameworkInterface to set
+ * @return void
+ */
+ public final function setExtraInstance (FrameworkInterface $extraInstance) {
+ $this->extraInstance = $extraInstance;
+ }
+
/**
* Assigns a field from the value instance with a template variable
*
// Is the value instance valid?
if (is_null($this->valueInstance)) {
- try {
- // Get the requested instance
- $this->valueInstance = ObjectFactory::createObjectByConfiguredName($registryKey . '_class', array($this->extraInstance));
- } catch (FrameworkException $e) {
- // Okay, nothing found so throw a null pointer exception here
- throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- }
+ // Get the requested instance
+ $this->valueInstance = ObjectFactory::createObjectByConfiguredName($registryKey . '_class', array($this->extraInstance));
} // END - if
}
// Add the group to the stack
$this->groups[$this->totalCounter] = $groupId;
- $this->groups[$groupId]['opened'] = true;
+ $this->groups[$groupId]['opened'] = TRUE;
$this->groups[$groupId]['content'] = sprintf(
- "<!-- group %s opened (length: %s, tag: %s) //-->%s\n",
+ '<!-- group %s opened (length: %s, tag: %s) //-->%s' . PHP_EOL,
$groupId,
strlen($content),
$tag,
} // END - if
// Check if any group was opened before
- if ($this->ifGroupOpenedPreviously() === false) {
+ if ($this->ifGroupOpenedPreviously() === FALSE) {
// Then throw an exception
throw new HelperNoPreviousOpenedGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
} // END - if
$this->groups[$groupId]['tag'],
$content
);
- $this->groups[$groupId]['opened'] = false;
+ $this->groups[$groupId]['opened'] = FALSE;
// Mark previous group as closed
$this->setPreviousGroupId('');
// Add the group to the stack
$this->subGroups[$this->totalCounter] = $subGroupId;
- $this->subGroups[$subGroupId]['opened'] = true;
+ $this->subGroups[$subGroupId]['opened'] = TRUE;
$this->subGroups[$subGroupId]['content'] = sprintf("<!-- sub-group %s opened (length: %s, tag: %s) //-->%s\n", $subGroupId, strlen($content), $tag, $content);
$this->subGroups[$subGroupId]['tag'] = $tag;
*/
public function closePreviousSubGroupByContent ($content = '') {
// Check if any sub group was opened before
- if ($this->ifSubGroupOpenedPreviously() === false) {
+ if ($this->ifSubGroupOpenedPreviously() === FALSE) {
// Then throw an exception
throw new HelperNoPreviousOpenedSubGroupException(array($this, $content), self::EXCEPTION_NO_PREVIOUS_SUB_GROUP_OPENED);
} // END - if
// Is the content empty?
if ((empty($content)) && (!empty($this->subGroups[$subGroupId]['tag']))) {
// Get it from opener
- $content = sprintf("<!-- sub-group %s auto-closed //--></%s>", $subGroupId, $this->subGroups[$subGroupId]['tag']);
+ $content = sprintf('<!-- sub-group %s auto-closed //--></%s>', $subGroupId, $this->subGroups[$subGroupId]['tag']);
} // END - if
// Add content to it and mark it as closed
- $this->subGroups[$subGroupId]['content'] .= sprintf("<!-- sub-group %s closed (length: %s, tag: %s) //-->%s\n", $subGroupId, strlen($content), $this->subGroups[$subGroupId]['tag'], $content);
- $this->subGroups[$subGroupId]['opened'] = false;
+ $this->subGroups[$subGroupId]['content'] .= sprintf('<!-- sub-group %s closed (length: %s, tag: %s) //-->%s' . PHP_EOL, $subGroupId, strlen($content), $this->subGroups[$subGroupId]['tag'], $content);
+ $this->subGroups[$subGroupId]['opened'] = FALSE
+ ;
// Mark previous sub group as closed
$this->setPreviousSubGroupId('');
// Is header content there?
if (isset($this->groups['header'])) {
// Then add it
- $content .= $this->groups['header']['content'] . chr(10);
+ $content .= $this->groups['header']['content'] . PHP_EOL;
} // END - if
// Initiate content
// Now "walk" through all groups and sub-groups
for ($idx = 1; $idx <= $this->totalCounter; $idx++) {
// Is this a sub/group and is it closed?
- if ((isset($this->groups[$idx])) && ($this->groups[$this->groups[$idx]]['opened'] === false)) {
+ if ((isset($this->groups[$idx])) && ($this->groups[$this->groups[$idx]]['opened'] === FALSE)) {
// Then add it's content
$groupContent = trim($this->groups[$this->groups[$idx]]['content']);
//* DEBUG: */ echo "group={$this->groups[$idx]},content=<pre>".htmlentities($groupContent)."</pre><br />\n";
$content .= $groupContent;
- } elseif ((isset($this->subGroups[$idx])) && ($this->subGroups[$this->subGroups[$idx]]['opened'] === false)) {
+ } elseif ((isset($this->subGroups[$idx])) && ($this->subGroups[$this->subGroups[$idx]]['opened'] === FALSE)) {
// Then add it's content
$subGroupContent = $this->subGroups[$this->subGroups[$idx]]['content'];
//* DEBUG: */ echo "subgroup={$this->subGroups[$idx]},content=<pre>".htmlentities($subGroupContent)."</pre><br />\n";
$content .= trim($subGroupContent);
} else {
// Something went wrong
- $this->debugInstance(__METHOD__."(): Something unexpected happened here.");
+ $this->debugInstance(__METHOD__ . '(): Something unexpected happened here.');
}
} // END - for
// Is footer content there?
if (isset($this->groups['footer'])) {
// Then add it
- $content .= $this->groups['footer']['content'] . chr(10);
+ $content .= $this->groups['footer']['content'] . PHP_EOL;
} // END - if
// Return it
*/
protected function ifGroupIsOpened ($groupId) {
// Is the group open?
- $isOpened = ((isset($this->groups[$groupId])) && ($this->groups[$groupId]['opened'] === true));
+ $isOpened = ((isset($this->groups[$groupId])) && ($this->groups[$groupId]['opened'] === TRUE));
// Return status
return $isOpened;
* @throws NullPointerException Thrown if $valueInstance is null
*/
public function getValueField ($fieldName) {
+ // Init value
+ $fieldValue = NULL;
+
// The $valueInstance attribute should not be null!
if (is_null($this->getValueInstance())) {
// Throws an exception here
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
} // END - if
- // Get the field value
- $fieldValue = $this->getValueInstance()->getField($fieldName);
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.'[]='.gettype($fieldValue).'('.strlen($fieldValue).')');
-
- // Is it null?
- if ((is_null($fieldValue)) && (!is_null($this->extraInstance))) {
+ // Is the field set?
+ if ($this->getValueInstance()->isFieldSet($fieldName)) {
+ // Get the field value
+ $fieldValue = $this->getValueInstance()->getField($fieldName);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.'[]='.gettype($fieldValue).'('.strlen($fieldValue).') - Value instance!');
+ } elseif ((!is_null($this->extraInstance)) && ($this->extraInstance->isFieldSet($fieldName))) {
// So try the extra instance
$fieldValue = $this->extraInstance->getField($fieldName);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.'[]='.gettype($fieldValue).'('.strlen($fieldValue).') - Extra instance!');
+ } else {
+ // Field is not set
+ if ((!is_null($this->extraInstance)) && ($fieldName == 'city_name')) die('<pre>'.print_r($this->extraInstance, TRUE).'</pre>');
+ $this->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] fieldName=' . $fieldName . ' is not set! - @TODO');
} // END - if
// Return it
projects / core.git / blobdiff