Spiral\Snapshotter\FileHandler

Complexity

Total Complexity

8

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	registerSnapshot()	0	6	2
A	saveSnapshot()	0	17	2
A	performRotation()	0	15	3

<?php

namespace Spiral\Snapshotter;

use Spiral\Core\Service;
use Spiral\Debug\Configs\SnapshotConfig;
use Spiral\Debug\SnapshotInterface;
use Spiral\Files\FileManager;
use Spiral\Files\FilesInterface;

class FileHandler extends Service implements HandlerInterface
{
    /** @var SnapshotConfig */
    private $config;

    /** @var FileManager */
    private $files;

    /**
     * FileHandler constructor.
     *
     * @param SnapshotConfig $config
     * @param FileManager    $files
     */
    public function __construct(SnapshotConfig $config, FileManager $files)
    {
        $this->config = $config;
        $this->files = $files;
    }

    /**
     * Create snapshot aggregation and aggregated snapshot and tie them together.
     *
     * @param SnapshotInterface $snapshot
     */
    public function registerSnapshot(SnapshotInterface $snapshot)
    {
        if ($this->config->reportingEnabled()) {
            $this->saveSnapshot($snapshot);
        }
    }

    /**
     * Save snapshot information on hard-drive.
     *
     * @param SnapshotInterface $snapshot
     */
    protected function saveSnapshot(SnapshotInterface $snapshot)
    {
        $filename = $this->config->snapshotFilename($snapshot->getException(), time());

It seems like $snapshot->getException() targeting Spiral\Debug\SnapshotInterface::getException() can also be of type object<Exception>; however, Spiral\Debug\Configs\SnapshotConfig::snapshotFilename() does only seem to accept object<Throwable>, maybe add an additional type check?

        $this->files->write(
            $filename,
            $snapshot->render(),
            FilesInterface::RUNTIME,
            true
        );

        //Rotating files
        $snapshots = $this->files->getFiles($this->config->reportingDirectory());
        if (count($snapshots) > $this->config->maxSnapshots()) {
            $this->performRotation($snapshots);
        }
    }

    /**
     * Clean old snapshots.
     *
     * @param array $snapshots
     */
    protected function performRotation(array $snapshots)
    {
        $oldest = '';
        $oldestTimestamp = PHP_INT_MAX;
        foreach ($snapshots as $snapshot) {
            $snapshotTimestamp = $this->files->time($snapshot);

            if ($snapshotTimestamp < $oldestTimestamp) {
                $oldestTimestamp = $snapshotTimestamp;
                $oldest = $snapshot;
            }
        }

        $this->files->delete($oldest);
    }
}