Merge pull request #3 from WyriHaximus/to-from-array

Convert a session to an from array for (JSON) encoding/decoding

Author: WyriHaximus

README.md

@@ -57,6 +57,17 @@ Using this middleware together with [`wyrihaximus/react-http-middleware-response
 please take a look at [`wyrihaximus/react-http-middleware-response-cache-session-cache-configuration`](https://github.com/WyriHaximus/reactphp-http-middleware-response-cache-session-cache-configuration) to 
 ensure you don't cache responses from users with active sessions.
 
+## To/From array
+
+In case you need to pass a session into a child process it has `toArray` and `fromArray` methods: 
+
+```php
+$array = $session->toArray();
+// Transfer to child process
+$session = (new Session('', [], new RandomBytes()))->fromArray($array);
+// The same can be done transferring changes back to the parent
+```
+
 # License
 
 The MIT License (MIT)

src/Session.php

@@ -122,4 +122,34 @@ public function regenerate(): bool
 
         return true;
     }
+
+    public function toArray(): array
+    {
+        return [
+            'id' => $this->id,
+            'contents' => $this->contents,
+            'oldIds' => $this->oldIds,
+            'status' => $this->status,
+        ];
+    }
+
+    /**
+     * @param  array                     $session
+     * @throws \InvalidArgumentException
+     * @return Session
+     */
+    public function fromArray(array $session): self
+    {
+        if (!isset($session['id']) || !isset($session['contents']) || !isset($session['oldIds']) || !isset($session['oldIds'])) {
+            throw new \InvalidArgumentException('Session array most contain "id", "contents", "oldIds", and "status".');
+        }
+
+        $clone = clone $this;
+        $clone->id = $session['id'];
+        $clone->contents = $session['contents'];
+        $clone->oldIds = $session['oldIds'];
+        $clone->status = $session['status'];
+
+        return $clone;
+    }
 }

tests/SessionTest.php

@@ -74,4 +74,36 @@ public function testState()
         ], $session->getOldIds());
         self::assertSame([], $session->getContents());
     }
+
+    public function testToFromArray()
+    {
+        $session = new Session('', [], new RandomBytes());
+
+        self::assertSame(
+            [
+                'id' => '',
+                'contents' => [],
+                'oldIds' => [],
+                'status' => 1,
+            ],
+            $session->toArray()
+        );
+
+        $session->begin();
+
+        self::assertSame(
+            [
+                'id' => $session->getId(),
+                'contents' => [],
+                'oldIds' => [],
+                'status' => 2,
+            ],
+            $session->toArray()
+        );
+
+        $array = $session->toArray();
+        $newSession = $session->fromArray($array);
+        self::assertNotSame($session, $newSession);
+        self::assertSame($array, $newSession->toArray());
+    }
 }