Fixing SplFixedArray not being serializable

Author: Nil Portugues Caldero

src/DeepCopySerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer;
 
 use ReflectionClass;

src/JsonSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer;
 
 use NilPortugues\Serializer\Strategy\JsonStrategy;

src/Serializer.php

@@ -3,6 +3,7 @@
 namespace NilPortugues\Serializer;
 
 use Closure;
+use NilPortugues\Serializer\Serializer\InternalClasses\SplFixedArraySerializer;
 use NilPortugues\Serializer\Strategy\StrategyInterface;
 use ReflectionClass;
 use ReflectionException;
@@ -146,6 +147,10 @@ protected function serializeData($value)
             // @codeCoverageIgnoreEnd
         }
 
+        if (is_object($value) && $value instanceof \SplFixedArray) {
+            return SplFixedArraySerializer::serialize($this, $value);
+        }
+
         if (\is_object($value)) {
             return $this->serializeObject($value);
         }
@@ -219,6 +224,10 @@ protected function unserializeData($value)
             return $this->getScalarValue($value);
         }
 
+        if (isset($value[self::CLASS_IDENTIFIER_KEY]) && 0 === strcmp($value[self::CLASS_IDENTIFIER_KEY], 'SplFixedArray')) {
+            return SplFixedArraySerializer::unserialize($this, $value[self::CLASS_IDENTIFIER_KEY], $value);
+        }
+
         if (isset($value[self::CLASS_IDENTIFIER_KEY])) {
             return $this->unserializeObject($value);
         }

src/Serializer/HHVM/DatePeriodSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Serializer\HHVM;
 
 /**

src/Serializer/HHVM/DateTimeImmutableSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Serializer\HHVM;
 
 use NilPortugues\Serializer\Serializer;

src/Serializer/HHVM/DateTimeSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Serializer\HHVM;
 
 use NilPortugues\Serializer\Serializer;

src/Serializer/InternalClasses/DateIntervalSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Serializer\InternalClasses;
 
 use DateInterval;

src/Serializer/InternalClasses/DatePeriodSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Serializer\InternalClasses;
 
 /**

src/Serializer/InternalClasses/DateTimeZoneSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Serializer\InternalClasses;
 
 use DateTimeZone;

src/Serializer/InternalClasses/SplFixedArraySerializer.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace NilPortugues\Serializer\Serializer\InternalClasses;
+
+use NilPortugues\Serializer\Serializer;
+use SplFixedArray;
+
+class SplFixedArraySerializer
+{
+    /**
+     * @param Serializer    $serializer
+     * @param SplFixedArray $splFixedArray
+     *
+     * @return array
+     */
+    public static function serialize(Serializer $serializer, SplFixedArray $splFixedArray)
+    {
+        $toArray = [
+            Serializer::CLASS_IDENTIFIER_KEY => get_class($splFixedArray),
+            Serializer::SCALAR_VALUE => [],
+        ];
+        foreach ($splFixedArray->toArray() as $key => $field) {
+            $toArray[Serializer::SCALAR_VALUE][$key] = $serializer->serialize($field);
+        }
+
+        return $toArray;
+    }
+
+    /**
+     * @param Serializer $serializer
+     * @param string     $className
+     * @param array      $value
+     *
+     * @return object
+     */
+    public static function unserialize(Serializer $serializer, $className, array $value)
+    {
+        $data = $serializer->unserialize($value[Serializer::SCALAR_VALUE]);
+
+        return $className::fromArray($data);
+    }
+}

src/Strategy/JsonStrategy.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Strategy;
 
 /**

src/Strategy/NullStrategy.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Strategy;
 
 /**

src/Strategy/StrategyInterface.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Strategy;
 
 interface StrategyInterface

src/Strategy/XmlStrategy.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Strategy;
 
 use NilPortugues\Serializer\Serializer;

src/Strategy/YamlStrategy.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Strategy;
 
 use Symfony\Component\Yaml\Yaml;

src/Transformer/AbstractTransformer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Transformer;
 
 use InvalidArgumentException;

src/Transformer/ArrayTransformer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Transformer;
 
 use NilPortugues\Serializer\Serializer;

src/Transformer/FlatArrayTransformer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Transformer;
 
 class FlatArrayTransformer  extends ArrayTransformer

src/Transformer/XmlTransformer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Transformer;
 
 use DOMDocument;

src/Transformer/YamlTransformer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer\Transformer;
 
 use Symfony\Component\Yaml\Yaml;

src/XmlSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer;
 
 use NilPortugues\Serializer\Strategy\XmlStrategy;

src/YamlSerializer.php

@@ -8,6 +8,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 namespace NilPortugues\Serializer;
 
 use NilPortugues\Serializer\Strategy\YamlStrategy;

tests/DeepCopySerializerTest.php

@@ -20,6 +20,7 @@
 use NilPortugues\Test\Serializer\Dummy\ComplexObject\ValueObject\CommentId;
 use NilPortugues\Test\Serializer\Dummy\ComplexObject\ValueObject\PostId;
 use NilPortugues\Test\Serializer\Dummy\ComplexObject\ValueObject\UserId;
+use SplFixedArray;
 
 class DeepCopySerializerTest extends \PHPUnit_Framework_TestCase
 {
@@ -78,4 +79,17 @@ public function testObjectStorageCopyDuringSerialization()
 
         $this->assertEquals($stdClass, $serializer->unserialize($serializedObject));
     }
+
+    public function testSplFixedArraySerialization()
+    {
+        $splFixedArray = new SplFixedArray(3);
+        $splFixedArray[0] = 1;
+        $splFixedArray[1] = 2;
+        $splFixedArray[2] = 3;
+
+        $serializer = new DeepCopySerializer(new NullStrategy());
+        $serializedObject = $serializer->serialize($splFixedArray);
+
+        $this->assertEquals($splFixedArray, $serializer->unserialize($serializedObject));
+    }
 }