Zenstruck\Governator\Throttle

Complexity

Total Complexity

7

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	acquire()	0	13	3
A	status()	0	3	1
A	hit()	0	3	1
A	reset()	0	3	1

<?php

namespace Zenstruck\Governator;

use Zenstruck\Governator\Exception\QuotaExceeded;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class Throttle
{
    private Store $store;
    private Key $key;

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

    /**
     * "Hits" the throttle, increasing its hit count by 1. If the throttle's quota is exceeded and
     * it resets in less than or equal to the passed time, block the process until the throttle is reset,
     * then "hit" it again.
     *
     * DOES NOT BLOCK the process if the throttle's quota is exceeded and its time until reset is greater
     * than the passed time.
     *
     * @param int $blockFor max number of seconds to block the process waiting for the throttle to reset
     *
     * @return Quota Information on the current state of the throttle
     *
     * @throws QuotaExceeded If the current hit exceeds the throttle's limit and the passed time
     *                       is less then the throttle's "time to live"
     */
    public function acquire(int $blockFor = 0): Quota
    {
        try {
            return $this->hit()->check();
        } catch (QuotaExceeded $exception) {
            if ($exception->resetsIn() > $blockFor) {
                throw $exception;
            }
        }

        sleep($exception->resetsIn());

        return $this->hit()->check();
    }

    /**
     * "Hits" the throttle, increasing its hit count by 1.
     */
    public function hit(): Quota
    {
        return new Quota($this->key, $this->store->hit($this->key));
    }

    /**
     * Fetches the current state of the throttle without increasing its hit count.
     */
    public function status(): Quota
    {
        return new Quota($this->key, $this->store->status($this->key));
    }

    /**
     * Resets the throttle.
     */
    public function reset(): void
    {
        $this->store->reset($this->key);
    }
}