Spiral\Session\Handler\FileHandler

Complexity

Total Complexity

11

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	destroy()	0	3	1
A	open()	0	3	1
A	__construct()	0	4	1
A	write()	0	7	1
A	read()	0	5	2
A	gc()	0	5	3
A	getFilename()	0	3	1
A	close()	0	3	1

<?php

/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

declare(strict_types=1);

namespace Spiral\Session\Handler;

use Spiral\Files\FilesInterface;

/**
 * Stores session data in file.
 */
final class FileHandler implements \SessionHandlerInterface
{
    /**
     * @var FilesInterface
     */
    protected $files;

    /**
     * @var string
     */
    protected $directory = '';

    /**
     * @param FilesInterface $files
     * @param string         $directory
     * @param int            $lifetime Default session lifetime.
     */
    public function __construct(FilesInterface $files, string $directory, int $lifetime = 0)

The parameter $lifetime is not used and could be removed.

    {
        $this->files = $files;
        $this->directory = $directory;
    }

    /**
     * @inheritdoc
     */
    public function close(): bool
    {
        return true;
    }

    /**
     * @inheritdoc
     * @codeCoverageIgnore
     */
    public function destroy($session_id): bool
    {
        return $this->files->delete($this->getFilename($session_id));
    }

    /**
     * @inheritdoc
     * @codeCoverageIgnore
     */
    public function gc($maxlifetime): void
    {
        foreach ($this->files->getFiles($this->directory) as $filename) {
            if ($this->files->time($filename) < time() - $maxlifetime) {
                $this->files->delete($filename);
            }
        }
    }

    /**
     * @inheritdoc
     */
    public function open($save_path, $session_id): bool
    {
        return true;
    }

    /**
     * @inheritdoc
     */
    public function read($session_id): string
    {
        return $this->files->exists($this->getFilename($session_id))
            ? $this->files->read($this->getFilename($session_id))
            : '';
    }

    /**
     * @inheritdoc
     */
    public function write($session_id, $session_data): bool
    {
        return $this->files->write(
            $this->getFilename($session_id),
            $session_data,
            FilesInterface::RUNTIME,
            true
        );
    }

    /**
     * Session data filename.
     *
     * @param string $session_id
     *
     * @return string
     */
    protected function getFilename($session_id): string
    {
        return "{$this->directory}/{$session_id}";
    }
}