Zenstruck\Governator\Exception\QuotaExceeded

Complexity

Total Complexity

8

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	hits()	0	3	1
A	__construct()	0	5	1
A	resetsIn()	0	3	1
A	quota()	0	3	1
A	remaining()	0	3	1
A	resource()	0	3	1
A	resetsAt()	0	3	1
A	limit()	0	3	1

<?php

namespace Zenstruck\Governator\Exception;

use Zenstruck\Governator\Quota;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class QuotaExceeded extends \RuntimeException
{
    private Quota $quota;

    public function __construct(Quota $quota)
    {
        $this->quota = $quota;

        parent::__construct(\sprintf('Quota Exceeded (%d/%d), resets in %d seconds.', $quota->hits(), $quota->limit(), $quota->resetsIn()));
    }

    /**
     * @return Quota The exceeded Quota object for the throttle
     */
    public function quota(): Quota
    {
        return $this->quota;
    }

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

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

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

    /**
     * @return int Number of allowed hits before the throttle resets (always 0)
     */
    public function remaining(): int
    {
        return 0;
    }

    /**
     * @return \DateTimeImmutable When the throttle resets (never in the past)
     */
    public function resetsAt(): \DateTimeImmutable
    {
        return $this->quota->resetsAt();
    }

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