eliashaeussler/cache-warmup

<?php

declare(strict_types=1);

/*
 * This file is part of the Composer package "eliashaeussler/cache-warmup".
 *
 * Copyright (C) 2020-2024 Elias Häußler <elias@haeussler.dev>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

namespace EliasHaeussler\CacheWarmup\Time;

use function round;

/**
 * Duration.
 *
 * @author Elias Häußler <elias@haeussler.dev>
 * @license GPL-3.0-or-later
 */
final class Duration
{
    public function __construct(
        private readonly float $milliseconds,
    ) {}

    public function get(): float
    {
        return $this->milliseconds;
    }

    public function format(): string
    {
        $seconds = $this->milliseconds / 1000;

        // Format with seconds
        if ($seconds >= 0.01) {
            return round($seconds, 3).'s';
        }

        // Format with milliseconds
        return round($this->milliseconds, 3).'ms';
    }
}