Added setter/getter for I/O streams
[core.git] / inc / classes / main / class_BaseFrameworkSystem.php
index 7f871069e191b3491441120a24c30248fa0c258d..7381073394eb646494a00c1563819eaf651bc5fd 100644 (file)
@@ -134,10 +134,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        private $helperInstance = null;
 
        /**
-        * An instance of a source
+        * An instance of a Sourceable class
         */
        private $sourceInstance = null;
 
+       /**
+        * An instance of a InputStreamable class
+        */
+       private $inputStreamInstance = null;
+
+       /**
+        * An instance of a OutputStreamable class
+        */
+       private $outputStreamInstance = null;
+
        /**
         * The real class name
         */
@@ -166,6 +176,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /***********************
         * Exception codes.... *
         ***********************/
+
        // @todo Try to clean these constants up
        const EXCEPTION_IS_NULL_POINTER              = 0x001;
        const EXCEPTION_IS_NO_OBJECT                 = 0x002;
@@ -225,6 +236,46 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
        const EXCEPTION_FILTER_CHAIN_INTERCEPTED     = 0x040;
 
+       // Hexadecimal->Decimal translation array
+       private static $hexdec = array(
+               '0' => 0,
+               '1' => 1,
+               '2' => 2,
+               '3' => 3,
+               '4' => 4,
+               '5' => 5,
+               '6' => 6,
+               '7' => 7,
+               '8' => 8,
+               '9' => 9,
+               'a' => 10,
+               'b' => 11,
+               'c' => 12,
+               'd' => 13,
+               'e' => 14,
+               'f' => 15
+       );
+
+       // Decimal->hexadecimal translation array
+       private static $dechex = array(
+                0 => '0',
+                1 => '1',
+                2 => '2',
+                3 => '3',
+                4 => '4',
+                5 => '5',
+                6 => '6',
+                7 => '7',
+                8 => '8',
+                9 => '9',
+               10 => 'a',
+               11 => 'b',
+               12 => 'c',
+               13 => 'd',
+               14 => 'e',
+               15 => 'f'
+       );
+
        /**
         * Protected super constructor
         *
@@ -1525,12 +1576,41 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Getter for a Sourceable instance
+        * Getter for a InputStreamable instance
         *
-        * @param       $sourceInstance The Sourceable instance
+        * @param       $inputStreamInstance    The InputStreamable instance
+        */
+       protected final function getInputStreamInstance () {
+               return $this->inputStreamInstance;
+       }
+
+       /**
+        * Setter for a InputStreamable instance
+        *
+        * @param       $inputStreamInstance    The InputStreamable instance
+        * @return      void
+        */
+       protected final function setInputStreamInstance (InputStreamable $inputStreamInstance) {
+               $this->inputStreamInstance = $inputStreamInstance;
+       }
+
+       /**
+        * Getter for a OutputStreamable instance
+        *
+        * @param       $outputStreamInstance   The OutputStreamable instance
         */
-       protected final function getSourceInstance () {
-               return $this->sourceInstance;
+       protected final function getOutputStreamInstance () {
+               return $this->outputStreamInstance;
+       }
+
+       /**
+        * Setter for a OutputStreamable instance
+        *
+        * @param       $outputStreamInstance   The OutputStreamable instance
+        * @return      void
+        */
+       protected final function setOutputStreamInstance (OutputStreamable $outputStreamInstance) {
+               $this->outputStreamInstance = $outputStreamInstance;
        }
 
        /**
@@ -1562,30 +1642,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @param       $hex    Hexadecimal string
         * @return      $dec    Decimal number
         */
-       function hex2dec ($hex) {
+       protected function hex2dec ($hex) {
                // Convert to all lower-case
                $hex = strtolower($hex);
 
-               // Hexadecimal->Decimal translation array
-               $hexdec = array(
-                       '0' => 0,
-                       '1' => 1,
-                       '2' => 2,
-                       '3' => 3,
-                       '4' => 4,
-                       '5' => 5,
-                       '6' => 6,
-                       '7' => 7,
-                       '8' => 8,
-                       '9' => 9,
-                       'a' => 10,
-                       'b' => 11,
-                       'c' => 12,
-                       'd' => 13,
-                       'e' => 14,
-                       'f' => 15
-               );
-
                // Detect sign (negative/positive numbers)
                $sign = '';
                if (substr($hex, 0, 1) == '-') {
@@ -1596,7 +1656,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Decode the hexadecimal string into a decimal number
                $dec = 0;
                for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
-                       $factor = $hexdec[substr($hex, $i, 1)];
+                       $factor = self::$hexdec[substr($hex, $i, 1)];
                        $dec = bcadd($dec, bcmul($factor, $e));
                } // END - for
 
@@ -1611,10 +1671,14 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * This work is based on comment #97756 on php.net documentation page at:
         * <http://de.php.net/manual/en/function.hexdec.php#97756>
         *
-        * @param       $dec    Decimal number, even with negative sign
+        * @param       $dec            Decimal number, even with negative sign
+        * @param       $maxLength      Optional maximum length of the string
         * @return      $hex    Hexadecimal string
         */
-       function dec2hex ($dec) {
+       protected function dec2hex ($dec, $maxLength = 0) {
+               // maxLength can be zero or devideable by 2
+               assert(($maxLength == 0) || (($maxLength % 2) == 0));
+
                // Detect sign (negative/positive numbers)
                $sign = '';
                if ($dec < 0) {
@@ -1622,36 +1686,122 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        $dec = abs($dec);
                } // END - if
 
-               // Decimal->hexadecimal translation array
-               $hexAlphabet = array(
-                        0 => '0',
-                        1 => '1',
-                        2 => '2',
-                        3 => '3',
-                        4 => '4',
-                        5 => '5',
-                        6 => '6',
-                        7 => '7',
-                        8 => '8',
-                        9 => '9',
-                       10 => 'a',
-                       11 => 'b',
-                       12 => 'c',
-                       13 => 'd',
-                       14 => 'e',
-                       15 => 'f'
-               );
-
                // Encode the decimal number into a hexadecimal string
                $hex = '';
                do {
-                       $hex = $hexAlphabet[($dec % 16)] . $hex;
+                       $hex = self::$dechex[($dec % 16)] . $hex;
                        $dec /= 16;
-               } while( $dec >= 1 );
+               } while ($dec >= 1);
+
+               /*
+                * We need hexadecimal strings with leading zeros if the length cannot
+                * be divided by 2
+                */
+               if ($maxLength > 0) {
+                       // Prepend more zeros
+                       $hex = $this->prependStringToString($hex, '0', $maxLength);
+               } elseif ((strlen($hex) % 2) != 0) {
+                       $hex = '0' . $hex;
+               }
 
                // Return the hexadecimal string
                return $sign . $hex;
        }
+
+       /**
+        * Converts a ASCII string (0 to 255) into a decimal number.
+        *
+        * @param       $asc    The ASCII string to be converted
+        * @return      $dec    Decimal number
+        */
+       protected function asc2dec ($asc) {
+               // Convert it into a hexadecimal number
+               $hex = bin2hex($asc);
+
+               // And back into a decimal number
+               $dec = $this->hex2dec($hex);
+
+               // Return it
+               return $dec;
+       }
+
+       /**
+        * Converts a decimal number into an ASCII string.
+        *
+        * @param       $dec            Decimal number
+        * @return      $asc    An ASCII string
+        */
+       protected function dec2asc ($dec) {
+               // First convert the number into a hexadecimal string
+               $hex = $this->dec2hex($dec);
+
+               // Then convert it into the ASCII string
+               $asc = $this->hex2asc($hex);
+
+               // Return it
+               return $asc;
+       }
+
+       /**
+        * Converts a hexadecimal number into an ASCII string. Negative numbers
+        * are not allowed.
+        *
+        * @param       $hex    Hexadecimal string
+        * @return      $asc    An ASCII string
+        */
+       protected function hex2asc ($hex) {
+               // Check for length, it must be devideable by 2
+               //* DEBUG: */ $this->debugOutput('hex='.$hex);
+               assert((strlen($hex) % 2) == 0);
+
+               // Walk the string
+               $asc = '';
+               for ($idx = 0; $idx < strlen($hex); $idx+=2) {
+                       // Get the decimal number of the chunk
+                       $part = hexdec(substr($hex, $idx, 2));
+
+                       // Add it to the final string
+                       $asc .= chr($part);
+               } // END - for
+
+               // Return the final string
+               return $asc;
+       }
+
+       /**
+        * Prepends a given string $prepend to $str with a given total length
+        *
+        * @param       $str            Given original string which should be prepended
+        * @param       $prepend        The string to prepend
+        * @param       $length         Total length of the final string
+        * @return      $strFinal       Final prepended string
+        */
+       protected function prependStringToString ($str, $prepend, $length) {
+               // Set final string to original string by default
+               $strFinal = $str;
+
+               // Can it devided
+               if (strlen($str) < $length) {
+                       // Difference between total length and length of original string
+                       $diff = $length - strlen($str);
+
+                       // Prepend the string
+                       $prepend = str_repeat($prepend, ($diff / strlen($prepend) + 1));
+
+                       // Make sure it will definedly fit
+                       assert(strlen($prepend) >= $diff);
+
+                       // Cut it a little down
+                       $prepend = substr($prepend, 0, $diff);
+                       //* DEBUG: */ $this->debugOutput('prepend('.strlen($prepend).')='.$prepend.',diff='.$diff.',length='.$length);
+
+                       // Construct the final prepended string
+                       $strFinal = $prepend . $str;
+               } // END - if
+
+               // Return it
+               return $strFinal;
+       }
 }
 
 // [EOF]