Updating Session code with PHP 8.1 features

CHANGELOG.md

@@ -50,6 +50,16 @@
     added return type `mixed` to the method `getContext` in `Spiral\Filters\FilterInterface` interface. 
     Added return type `mixed` to the method `getValue` in `Spiral\Filters\InputInterface`.
   - [spiral/http] Config `Spiral\Config\JsonPayloadConfig` moved to the `Spiral\Bootloader\Http\JsonPayloadConfig`.
+  - [spiral/session] Added return type `void` to the method `resume` in `Spiral\Session\SessionInterface`.
+  - [spiral/session] Added return type `self` and `mixed` parameter type of `$value` to the method `set` 
+    in `Spiral\Session\SessionSectionInterface`.
+  - [spiral/session] Added return type `bool` to the method `has` in `Spiral\Session\SessionSectionInterface`.
+  - [spiral/session] Added return type `mixed` and `mixed` parameter type of `$default` to the method `get`
+    in `Spiral\Session\SessionSectionInterface`.
+  - [spiral/session] Added return type `mixed` and `mixed` parameter type of `$default` to the method `pull`
+    in `Spiral\Session\SessionSectionInterface`.
+  - [spiral/session] Added return type `void` to the method `delete` in `Spiral\Session\SessionSectionInterface`.
+  - [spiral/session] Added return type `void` to the method `clear` in `Spiral\Session\SessionSectionInterface`.
   - [spiral/pagination] Added return type `self` to the method `limit`, added return type `self` to the method `offset`
     in `Spiral\Pagination\PaginableInterface`
   - [spiral/prototype] Parameter `$printer` now is not nullable in `Spiral\Prototype\Injector` constructor.

src/Framework/Session/SectionScope.php

@@ -4,8 +4,6 @@
 
 namespace Spiral\Session;
 
-use Spiral\Core\Exception\ScopeException;
-
 final class SectionScope implements SessionSectionInterface
 {
     public function __construct(
@@ -72,9 +70,9 @@ public function getAll(): array
         return $this->getActiveSection()->getAll();
     }
 
-    public function set(string $name, mixed $value): void
+    public function set(string $name, mixed $value): SessionSectionInterface
     {
-        $this->getActiveSection()->set($name, $value);
+        return $this->getActiveSection()->set($name, $value);
     }
 
     public function has(string $name): bool
@@ -102,9 +100,6 @@ public function clear(): void
         $this->getActiveSection()->clear();
     }
 
-    /**
-     * @throws ScopeException
-     */
     private function getActiveSection(): SessionSectionInterface
     {
         return $this->session->getActiveSession()->getSection($this->name);

src/Session/src/Config/SessionConfig.php

@@ -1,12 +1,5 @@
 <?php
 
-/**
- * Spiral Framework.
- *
- * @license   MIT
- * @author    Anton Titov (Wolfy-J)
- */
-
 declare(strict_types=1);
 
 namespace Spiral\Session\Config;
@@ -61,7 +54,7 @@ public function getHandler(): ?Autowire
             return $this->config['handler'];
         }
 
-        if (class_exists($this->config['handler'])) {
+        if (\class_exists($this->config['handler'])) {
             return new Autowire($this->config['handler']);
         }
 

src/Session/src/Exception/MultipleSessionException.php

@@ -1,12 +1,5 @@
 <?php
 
-/**
- * Spiral Framework.
- *
- * @license   MIT
- * @author    Anton Titov (Wolfy-J)
- */
-
 declare(strict_types=1);
 
 namespace Spiral\Session\Exception;

src/Session/src/Exception/SessionException.php

@@ -1,12 +1,5 @@
 <?php
 
-/**
- * Spiral Framework.
- *
- * @license   MIT
- * @author    Anton Titov (Wolfy-J)
- */
-
 declare(strict_types=1);
 
 namespace Spiral\Session\Exception;

src/Session/src/Handler/FileHandler.php

@@ -1,12 +1,5 @@
 <?php
 
-/**
- * Spiral Framework.
- *
- * @license   MIT
- * @author    Anton Titov (Wolfy-J)
- */
-
 declare(strict_types=1);
 
 namespace Spiral\Session\Handler;
@@ -18,96 +11,59 @@
  */
 final class FileHandler implements \SessionHandlerInterface
 {
-    /**
-     * @var FilesInterface
-     */
-    protected $files;
-
-    /**
-     * @var string
-     */
-    protected $directory = '';
-
-    /**
-     * @param int            $lifetime Default session lifetime.
-     */
-    public function __construct(FilesInterface $files, string $directory)
-    {
-        $this->files = $files;
-        $this->directory = $directory;
+    public function __construct(
+        private readonly FilesInterface $files,
+        private readonly string $directory
+    ) {
     }
 
-    /**
-     * @inheritdoc
-     */
     public function close(): bool
     {
         return true;
     }
 
     /**
-     * @inheritdoc
      * @codeCoverageIgnore
      */
-    public function destroy($session_id): bool
+    public function destroy(string $id): bool
     {
-        return $this->files->delete($this->getFilename($session_id));
+        return $this->files->delete($this->getFilename($id));
     }
 
     /**
-     * @inheritdoc
      * @codeCoverageIgnore
      */
-    #[\ReturnTypeWillChange]
-    public function gc($maxlifetime)
+    public function gc(int $maxlifetime): int
     {
         foreach ($this->files->getFiles($this->directory) as $filename) {
-            if ($this->files->time($filename) < time() - $maxlifetime) {
+            if ($this->files->time($filename) < \time() - $maxlifetime) {
                 $this->files->delete($filename);
             }
         }
 
         return $maxlifetime;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function open($save_path, $session_id): bool
+    public function open(string $path, string $id): bool
     {
         return true;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function read($session_id): string
+    public function read(string $id): string
     {
-        return $this->files->exists($this->getFilename($session_id))
-            ? $this->files->read($this->getFilename($session_id))
-            : '';
+        return $this->files->exists($this->getFilename($id)) ? $this->files->read($this->getFilename($id)) : '';
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function write($session_id, $session_data): bool
+    public function write(string $id, string $data): bool
     {
-        return $this->files->write(
-            $this->getFilename($session_id),
-            $session_data,
-            FilesInterface::RUNTIME,
-            true
-        );
+        return $this->files->write($this->getFilename($id), $data, FilesInterface::RUNTIME, true);
     }
 
     /**
      * Session data filename.
-     *
-     * @param string $session_id
      */
-    protected function getFilename($session_id): string
+    protected function getFilename($id): string
     {
-        return "{$this->directory}/{$session_id}";
+        return \sprintf('%s/%s', $this->directory, $id);
     }
 }

src/Session/src/Handler/NullHandler.php

@@ -1,12 +1,5 @@
 <?php
 
-/**
- * Spiral Framework.
- *
- * @license   MIT
- * @author    Anton Titov (Wolfy-J)
- */
-
 declare(strict_types=1);
 
 namespace Spiral\Session\Handler;
@@ -16,51 +9,32 @@
  */
 final class NullHandler implements \SessionHandlerInterface
 {
-    /**
-     * @inheritdoc
-     */
     public function close(): bool
     {
         return true;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function destroy($session_id): bool
+    public function destroy(string $id): bool
     {
         return true;
     }
 
-    /**
-     * @inheritdoc
-     */
-    #[\ReturnTypeWillChange]
-    public function gc($maxlifetime)
+    public function gc(int $maxlifetime): int
     {
         return $maxlifetime;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function open($save_path, $session_id): bool
+    public function open(string $path, string $id): bool
     {
         return true;
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function read($session_id): string
+    public function read(string $id): string
     {
         return '';
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function write($session_id, $session_data): bool
+    public function write(string $id, string $data): bool
     {
         return true;
     }