Updated codebase to new style rulesets and php 7.4

Author: shudd3r

cs-fixer.php.dist

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 /*
  * This file is part of Polymorphine/Session package.

src/SessionContext.php

@@ -14,7 +14,15 @@
 
 interface SessionContext
 {
+    /**
+     * Orders to regenerate session id.
+     */
     public function reset(): void;
 
+    /**
+     * Saves data from session storage.
+     *
+     * @param array $data
+     */
     public function commit(array $data): void;
 }

src/SessionContext/NativeSessionContext.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 /*
  * This file is part of Polymorphine/Session package.
@@ -15,6 +15,7 @@
 use Polymorphine\Session\SessionContext;
 use Polymorphine\Session\SessionStorageProvider;
 use Polymorphine\Session\SessionStorage;
+use Polymorphine\Session\SessionStorage\ContextSessionStorage;
 use Polymorphine\Headers\Cookie;
 use Psr\Http\Server\RequestHandlerInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -24,13 +25,15 @@
 
 class NativeSessionContext implements MiddlewareInterface, SessionContext, SessionStorageProvider
 {
-    /** @var SessionStorage\ContextSessionStorage */
-    private $sessionData;
-    private $cookie;
+    private ContextSessionStorage $sessionData;
+    private Cookie                $cookie;
 
-    private $sessionStarted = false;
-    private $regenerateId   = false;
+    private bool $sessionStarted = false;
+    private bool $regenerateId   = false;
 
+    /**
+     * @param Cookie $cookie
+     */
     public function __construct(Cookie $cookie)
     {
         $this->cookie = $cookie;
@@ -39,7 +42,7 @@ public function __construct(Cookie $cookie)
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         if ($this->containsSessionCookie($request)) { $this->start(); }
-        $this->sessionData = new SessionStorage\ContextSessionStorage($this, $_SESSION ?? []);
+        $this->sessionData = new ContextSessionStorage($this, $_SESSION ?? []);
 
         $response = $handler->handle($request);
         $this->sessionData->commit();
@@ -49,7 +52,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
 
     public function storage(): SessionStorage
     {
-        if (!$this->sessionData) {
+        if (!isset($this->sessionData)) {
             throw new RuntimeException('Session context not started');
         }
         return $this->sessionData;

src/SessionStorage.php

@@ -16,17 +16,48 @@ interface SessionStorage
 {
     public const USER_KEY = 'session.user.id';
 
-    public function userId();
-
-    public function newUserContext($userId = null): void;
-
+    /**
+     * By default an alias to SessionStorage::get('session.user.id').
+     *
+     * @return mixed User id stored within session data
+     */
+    public function userId(): ?string;
+
+    /**
+     * By default an alias to SessionStorage::set('session.user.id', $value).
+     *
+     * @param string|null $userId
+     */
+    public function newUserContext(string $userId = null): void;
+
+    /**
+     * @param string $key
+     *
+     * @return bool
+     */
     public function has(string $key): bool;
 
+    /**
+     * @param string $key
+     * @param null   $default
+     *
+     * @return mixed
+     */
     public function get(string $key, $default = null);
 
+    /**
+     * @param string $key
+     * @param $value
+     */
     public function set(string $key, $value): void;
 
+    /**
+     * @param string $key
+     */
     public function remove(string $key): void;
 
+    /**
+     * Removes all data stored in session.
+     */
     public function clear(): void;
 }

src/SessionStorage/ContextSessionStorage.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 /*
  * This file is part of Polymorphine/Session package.
@@ -18,24 +18,28 @@
 
 class ContextSessionStorage implements SessionStorage
 {
-    private $context;
-    private $userId;
-    private $data;
+    private SessionContext $context;
+    private array          $data;
+    private ?string        $userId;
 
+    /**
+     * @param SessionContext $context
+     * @param array          $data
+     */
     public function __construct(SessionContext $context, array $data = [])
     {
         $this->context = $context;
         $this->userId  = $this->pullUserId($data);
         $this->data    = $data;
     }
 
-    public function newUserContext($userId = null): void
+    public function newUserContext(string $userId = null): void
     {
         $this->userId = $userId;
         $this->context->reset();
     }
 
-    public function userId()
+    public function userId(): ?string
     {
         return $this->userId;
     }
@@ -70,6 +74,9 @@ public function clear(): void
         $this->newUserContext();
     }
 
+    /**
+     * Orders to pass stored data to session context.
+     */
     public function commit(): void
     {
         $userId = $this->userId ? [self::USER_KEY => $this->userId] : [];

src/SessionStorage/LazySessionStorage.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 /*
  * This file is part of Polymorphine/Session package.
@@ -17,15 +17,18 @@
 
 class LazySessionStorage implements SessionStorage
 {
-    private $storage;
-    private $provider;
+    private SessionStorageProvider $provider;
+    private SessionStorage         $storage;
 
+    /**
+     * @param SessionStorageProvider $provider
+     */
     public function __construct(SessionStorageProvider $provider)
     {
         $this->provider = $provider;
     }
 
-    public function userId()
+    public function userId(): ?string
     {
         return $this->storage()->userId();
     }
@@ -62,6 +65,6 @@ public function clear(): void
 
     private function storage(): SessionStorage
     {
-        return $this->storage ?: $this->storage = $this->provider->storage();
+        return $this->storage ??= $this->provider->storage();
     }
 }

src/SessionStorageProvider.php

@@ -14,5 +14,8 @@
 
 interface SessionStorageProvider
 {
+    /**
+     * @return SessionStorage Interface specialized to access & modify session data
+     */
     public function storage(): SessionStorage;
 }

tests/Doubles/DummyResponse.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 /*
  * This file is part of Polymorphine/Session package.
@@ -17,59 +17,75 @@
 
 class DummyResponse implements ResponseInterface
 {
-    public function getProtocolVersion()
+    public ?StreamInterface $stream;
+
+    public function getProtocolVersion(): string
     {
+        return '1.1';
     }
 
-    public function withProtocolVersion($version)
+    public function withProtocolVersion($version): self
     {
+        return $this;
     }
 
-    public function getHeaders()
+    public function getHeaders(): array
     {
+        return [];
     }
 
-    public function hasHeader($name)
+    public function hasHeader($name): bool
     {
+        return false;
     }
 
-    public function getHeader($name)
+    public function getHeader($name): array
     {
+        return [];
     }
 
-    public function getHeaderLine($name)
+    public function getHeaderLine($name): string
     {
+        return 'Header: data';
     }
 
-    public function withHeader($name, $value)
+    public function withHeader($name, $value): self
     {
+        return $this;
     }
 
-    public function withAddedHeader($name, $value)
+    public function withAddedHeader($name, $value): self
     {
+        return $this;
     }
 
-    public function withoutHeader($name)
+    public function withoutHeader($name): self
     {
+        return $this;
     }
 
-    public function getBody()
+    public function getBody(): StreamInterface
     {
+        return $this->stream;
     }
 
-    public function withBody(StreamInterface $body)
+    public function withBody(StreamInterface $body): self
     {
+        return $this;
     }
 
-    public function getStatusCode()
+    public function getStatusCode(): int
     {
+        return 200;
     }
 
-    public function withStatus($code, $reasonPhrase = '')
+    public function withStatus($code, $reasonPhrase = ''): self
     {
+        return $this;
     }
 
     public function getReasonPhrase()
     {
+        return $this;
     }
 }

tests/Doubles/FakeRequestHandler.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 /*
  * This file is part of Polymorphine/Session package.
@@ -18,16 +18,16 @@
 
 class FakeRequestHandler implements RequestHandlerInterface
 {
-    private $sideEffect;
+    private $process;
 
-    public function __construct(callable $sideEffect = null)
+    public function __construct(callable $process = null)
     {
-        $this->sideEffect = $sideEffect;
+        $this->process = $process;
     }
 
     public function handle(ServerRequestInterface $request): ResponseInterface
     {
-        if ($this->sideEffect) { ($this->sideEffect)(); }
+        if ($this->process) { ($this->process)(); }
         return new DummyResponse();
     }
 }