Use PHP_EOL instead of chr(10)
[core.git] / inc / classes / main / helper / class_BaseHelper.php
index da4f6b12b3f0fffe558ac1d0ab99c5c4539b341b..0b7e06ad5ce3f3f24ba5f7e248d6a30adb5192cc 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -25,7 +25,12 @@ class BaseHelper extends BaseFrameworkSystem {
        /**
         * Instance to the class which provides field values
         */
-       private $valueInstance = null;
+       private $valueInstance = NULL;
+
+       /**
+        * Extra instance to the class which provides field values
+        */
+       private $extraInstance = NULL;
 
        /**
         * Rendered content created by the helper class
@@ -58,9 +63,6 @@ class BaseHelper extends BaseFrameworkSystem {
        private $totalCounter = 0;
 
        // Exception constants
-       const EXCEPTION_XML_PARSER_ERROR             = 0x1e0;
-       const EXCEPTION_XML_NODE_UNKNOWN             = 0x1e1;
-       const EXCEPTION_XML_NODE_MISMATCH            = 0x1e2;
        const EXCEPTION_GROUP_NOT_OPENED             = 0x1e3;
        const EXCEPTION_GROUP_ALREADY_FOUND          = 0x1e4;
        const EXCEPTION_SUB_GROUP_ALREADY_FOUND      = 0x1e5;
@@ -85,7 +87,7 @@ class BaseHelper extends BaseFrameworkSystem {
         * @return      void
         */
        protected final function addContent ($newContent) {
-               $this->content .= (string) trim($newContent) . "\n";
+               $this->content .= (string) trim($newContent) . PHP_EOL;
        }
 
        /**
@@ -173,6 +175,7 @@ class BaseHelper extends BaseFrameworkSystem {
        public function assignFieldWithFilter ($fieldName, $filterMethod) {
                // Get the value
                $fieldValue = $this->getValueField($fieldName);
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.'='.$fieldValue);
 
                // Now filter it through the value through the filter method
                $filteredValue = call_user_func_array(array($this, 'doFilter' . $this->convertToClassName($filterMethod)), array($fieldValue));
@@ -189,29 +192,34 @@ class BaseHelper extends BaseFrameworkSystem {
         * @return      void
         * @throws      NullPointerException    If recovery of requested value instance failed
         */
-       public function prefetchValueInstance ($registryKey, $extraKey = null) {
+       public function prefetchValueInstance ($registryKey, $extraKey = NULL) {
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('O:'.$registryKey.'/'.$extraKey);
                try {
                        // Get the required instance
                        $this->valueInstance = Registry::getRegistry()->getInstance($registryKey);
                } catch (NullPointerException $e) {
                        // Not set in registry
                        // @TODO Try to log it here
+                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($registryKey.'=NULL!');
                }
 
-               // Is the value instance valid?
-               if (is_null($this->valueInstance)) {
-                       // Try to create it "from scratch", by first init extra instance
-                       $extraInstance = null;
-
-                       // Shall we get an extra instance?
-                       if (!is_null($extraKey)) {
+               // Shall we get an extra instance?
+               if (!is_null($extraKey)) {
+                       try {
                                // Get the extra instance.
-                               $extraInstance = Registry::getRegistry()->getInstance($extraKey);
-                       } // END - if
+                               $this->extraInstance = Registry::getRegistry()->getInstance($extraKey);
+                       } catch (NullPointerException $e) {
+                               // Try to create it
+                               $this->extraInstance = ObjectFactory::createObjectByConfiguredName($extraKey . '_class', array($this->valueInstance));
+                       }
+                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($extraKey.'='.$this->extraInstance.' - EXTRA!');
+               } // END - if
 
+               // Is the value instance valid?
+               if (is_null($this->valueInstance)) {
                        try {
                                // Get the requested instance
-                               $this->valueInstance = ObjectFactory::createObjectByConfiguredName($registryKey . '_class', array($extraInstance));
+                               $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);
@@ -383,7 +391,7 @@ class BaseHelper extends BaseFrameworkSystem {
                // Is header content there?
                if (isset($this->groups['header'])) {
                        // Then add it
-                       $content .= $this->groups['header']['content'] . "\n";
+                       $content .= $this->groups['header']['content'] . PHP_EOL;
                } // END - if
 
                // Initiate content
@@ -391,7 +399,7 @@ class BaseHelper extends BaseFrameworkSystem {
 
                // Now "walk" through all groups and sub-groups
                for ($idx = 1; $idx <= $this->totalCounter; $idx++) {
-                       // Is this a group and is it closed?
+                       // Is this a sub/group and is it closed?
                        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']);
@@ -411,7 +419,7 @@ class BaseHelper extends BaseFrameworkSystem {
                // Is footer content there?
                if (isset($this->groups['footer'])) {
                        // Then add it
-                       $content .= $this->groups['footer']['content'] . "\n";
+                       $content .= $this->groups['footer']['content'] . PHP_EOL;
                } // END - if
 
                // Return it
@@ -420,10 +428,10 @@ class BaseHelper extends BaseFrameworkSystem {
        }
 
        /**
-        * Checks wether the specified group is opened
+        * Checks whether the specified group is opened
         *
         * @param       $groupId        Id of group to check
-        * @return      $isOpened       Wether the specified group is open
+        * @return      $isOpened       Whether the specified group is open
         */
        protected function ifGroupIsOpened ($groupId) {
                // Is the group open?
@@ -438,15 +446,24 @@ class BaseHelper extends BaseFrameworkSystem {
         *
         * @param       $fieldName              Name of the field we shall fetch
         * @return      $fieldValue             Value from field
+        * @throws      NullPointerException    Thrown if $valueInstance is null
         */
        public function getValueField ($fieldName) {
-               // Construct the eval() command
-               $eval = sprintf("\$fieldValue = \$this->getValueInstance()->getField('%s');",
-                       $fieldName
-               );
+               // 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
-               eval($eval);
+               $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))) {
+                       // So try the extra instance
+                       $fieldValue = $this->extraInstance->getField($fieldName);
+               } // END - if
 
                // Return it
                return $fieldValue;
@@ -462,9 +479,9 @@ class BaseHelper extends BaseFrameworkSystem {
        }
 
        /**
-        * Check wether a group was opened previously
+        * Check whether a group was opened previously
         *
-        * @return      $groupOpened    Wether any group was opened before
+        * @return      $groupOpened    Whether any group was opened before
         */
        protected final function ifGroupOpenedPreviously () {
                $groupOpened = (!empty($this->previousGroupId));
@@ -472,9 +489,9 @@ class BaseHelper extends BaseFrameworkSystem {
        }
 
        /**
-        * Check wether a group was opened previously
+        * Check whether a group was opened previously
         *
-        * @return      $subGroupOpened         Wether any group was opened before
+        * @return      $subGroupOpened         Whether any group was opened before
         */
        protected final function ifSubGroupOpenedPreviously () {
                $subGroupOpened = (!empty($this->previousSubGroupId));