Add documentation

Author: Riimu

src/Encoder/FloatEncoder.php

@@ -121,7 +121,7 @@ private function encodeFloat($float, $precision)
     {
         $log = (int) floor(log(abs($float), 10));
 
-        if (abs($float) < self::FLOAT_MAX && $log > -5 && abs($log) < $precision) {
+        if ($log > -5 && abs($float) < self::FLOAT_MAX && abs($log) < $precision) {
             return $this->formatFloat($float, $precision - $log - 1);
         }
 

src/Encoder/IntegerEncoder.php

@@ -15,19 +15,15 @@ class IntegerEncoder implements Encoder
         'integer.type' => 'decimal',
     ];
 
-    public function getDefaultOptions()
-    {
-        return self::$defaultOptions;
-    }
-
-    public function supports($value)
-    {
-        return is_int($value);
-    }
+    /** @var \Closure[] Encoders for different types of integers */
+    private $encoders;
 
-    public function encode($value, $depth, array $options, callable $encode)
+    /**
+     * IntegerEncoder constructor.
+     */
+    public function __construct()
     {
-        $encoders = [
+        $this->encoders = [
             'binary' => function ($value) {
                 return $this->encodeBinary($value);
             },
@@ -41,12 +37,25 @@ public function encode($value, $depth, array $options, callable $encode)
                 return $this->encodeHexadecimal($value);
             },
         ];
+    }
 
-        if (!isset($encoders[$options['integer.type']])) {
+    public function getDefaultOptions()
+    {
+        return self::$defaultOptions;
+    }
+
+    public function supports($value)
+    {
+        return is_int($value);
+    }
+
+    public function encode($value, $depth, array $options, callable $encode)
+    {
+        if (!isset($this->encoders[$options['integer.type']])) {
             throw new \InvalidArgumentException('Invalid integer encoding type');
         }
 
-        $callback = $encoders[$options['integer.type']];
+        $callback = $this->encoders[$options['integer.type']];
 
         return $callback((int) $value, $options);
     }

src/Encoder/StringEncoder.php

@@ -82,6 +82,7 @@ private function getSingleQuotedString($string)
     /**
      * Returns the string wrapped in double quotes and all but print characters escaped.
      * @param string $string String to wrap and escape
+     * @param array $options String encoding options
      * @return string The string wrapped in double quotes and escape correctly
      */
     private function getDoubleQuotedString($string, $options)
@@ -108,6 +109,11 @@ function ($matches) {
         ));
     }
 
+    /**
+     * Encodes all multibyte UTF-8 characters into PHP7 string encoding
+     * @param string $string The string to encoder
+     * @return string The string with all the multibyte characters encoded
+     */
     private function encodeUtf8($string)
     {
         $pattern =
@@ -124,6 +130,11 @@ private function encodeUtf8($string)
         }, $string);
     }
 
+    /**
+     * Returns the unicode code point for the given multibyte UTF-8 character.
+     * @param string $bytes The multibyte character
+     * @return int The code point for the multibyte character
+     */
     private function getCodePoint($bytes)
     {
         if (strlen($bytes) === 2) {

tests/tests/EncodingTest.php

@@ -240,6 +240,7 @@ public function testUtf8String()
         $encoder = new PHPEncoder(['string.utf8' => true]);
 
         $this->assertEncode('"\nA"', "\nA", $encoder);
+        $this->assertEncode('"\nA\u{c4}\x00"', "\nAÄ\x00", $encoder);
 
         if (version_compare(PHP_VERSION, '7', '<')) {
             $this->assertSame('"\u{a2}"', $encoder->encode("\xC2\xA2"));