zenstruck / governator

src/Quota.php

<?php

namespace Zenstruck\Governator;

use Zenstruck\Governator\Exception\QuotaExceeded;

/**
 * Information on the current state of the throttle.
 *
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class Quota
{
    private Key $key;
    private Counter $counter;

    public function __construct(Key $key, Counter $counter)
    {
        $this->key = $key;
        $this->counter = $counter;
    }

    /**
     * @return Key The key used to create the throttle
     */
    public function key(): Key
    {
        return $this->key;
    }

    /**
     * @return string The throttle's unique identifier
     */
    public function resource(): string
    {
        return $this->key->resource();
    }

    /**
     * @return int The throttle's limit
     */
    public function limit(): int
    {
        return $this->key->limit();
    }

    /**
     * @return int The number of throttle hits
     */
    public function hits(): int
    {
        return $this->counter->hits();
    }

    /**
     * @return int Number of allowed hits before the throttle resets (never negative)
     */
    public function remaining(): int
    {
        return \max(0, $this->limit() - $this->hits());
    }

    /**
     * @return \DateTimeImmutable When the throttle resets (never in the past)
     */
    public function resetsAt(): \DateTimeImmutable
    {
        return \DateTimeImmutable::createFromFormat('U', $this->counter->resetsAt());

The expression return DateTimeImmutable::createFromFormat('U', $this->counter->resetsAt()) could return the type false which is incompatible with the type-hinted return DateTimeImmutable. Consider adding an additional type-check to rule them out.

    }

    /**
     * @return int Number of seconds until the throttle resets (never negative)
     */
    public function resetsIn(): int
    {
        return $this->counter->resetsIn();
    }

    public function hasBeenExceeded(): bool
    {
        return $this->counter->hits() > $this->limit();
    }

    /**
     * @throws QuotaExceeded If the throttle has been exceeded
     */
    public function check(): self
    {
        if ($this->hasBeenExceeded()) {
            throw new QuotaExceeded($this);
        }

        return $this;
    }
}