Limit.php

TLDR

The Limit.php file in the Illuminate\Cache\RateLimiting namespace contains a Limit class that represents a rate limit. It has properties for the rate limit key, maximum number of attempts, and decay seconds. It also has methods for creating rate limits for different time intervals and for setting the rate limit key and the callback for generating the response when the limit is exceeded.

Classes

Limit

The Limit class represents a rate limit. It has the following properties:

• $key: The rate limit signature key.
• $maxAttempts: The maximum number of attempts allowed within the given number of seconds.
• $decaySeconds: The number of seconds until the rate limit is reset.
• $responseCallback: The response generator callback.

The Limit class has the following methods:

• __construct($key = '', int $maxAttempts = 60, int $decaySeconds = 60): Constructor method to create a new limit instance.
• perSecond($maxAttempts): Static method to create a new rate limit with a rate of attempts per second.
• perMinute($maxAttempts): Static method to create a new rate limit with a rate of attempts per minute.
• perMinutes($decayMinutes, $maxAttempts): Static method to create a new rate limit with a rate of attempts per specified number of minutes.
• perHour($maxAttempts, $decayHours = 1): Static method to create a new rate limit with a rate of attempts per hour.
• perDay($maxAttempts, $decayDays = 1): Static method to create a new rate limit with a rate of attempts per day.
• none(): Static method to create a new unlimited rate limit.
• by($key): Method to set the key of the rate limit.
• response(callable $callback): Method to set the callback that should generate the response when the limit is exceeded.

<?php

namespace Illuminate\Cache\RateLimiting;

class Limit
{
    /**
     * The rate limit signature key.
     *
     * @var mixed
     */
    public $key;

    /**
     * The maximum number of attempts allowed within the given number of seconds.
     *
     * @var int
     */
    public $maxAttempts;

    /**
     * The number of seconds until the rate limit is reset.
     *
     * @var int
     */
    public $decaySeconds;

    /**
     * The response generator callback.
     *
     * @var callable
     */
    public $responseCallback;

    /**
     * Create a new limit instance.
     *
     * @param  mixed  $key
     * @param  int  $maxAttempts
     * @param  int  $decaySeconds
     * @return void
     */
    public function __construct($key = '', int $maxAttempts = 60, int $decaySeconds = 60)
    {
        $this->key = $key;
        $this->maxAttempts = $maxAttempts;
        $this->decaySeconds = $decaySeconds;
    }

    /**
     * Create a new rate limit.
     *
     * @param  int  $maxAttempts
     * @return static
     */
    public static function perSecond($maxAttempts)
    {
        return new static('', $maxAttempts, 1);
    }

    /**
     * Create a new rate limit.
     *
     * @param  int  $maxAttempts
     * @return static
     */
    public static function perMinute($maxAttempts)
    {
        return new static('', $maxAttempts, 60);
    }

    /**
     * Create a new rate limit using minutes as decay time.
     *
     * @param  int  $decayMinutes
     * @param  int  $maxAttempts
     * @return static
     */
    public static function perMinutes($decayMinutes, $maxAttempts)
    {
        return new static('', $maxAttempts, 60 * $decayMinutes);
    }

    /**
     * Create a new rate limit using hours as decay time.
     *
     * @param  int  $maxAttempts
     * @param  int  $decayHours
     * @return static
     */
    public static function perHour($maxAttempts, $decayHours = 1)
    {
        return new static('', $maxAttempts, 60 * 60 * $decayHours);
    }

    /**
     * Create a new rate limit using days as decay time.
     *
     * @param  int  $maxAttempts
     * @param  int  $decayDays
     * @return static
     */
    public static function perDay($maxAttempts, $decayDays = 1)
    {
        return new static('', $maxAttempts, 60 * 60 * 24 * $decayDays);
    }

    /**
     * Create a new unlimited rate limit.
     *
     * @return static
     */
    public static function none()
    {
        return new Unlimited;
    }

    /**
     * Set the key of the rate limit.
     *
     * @param  mixed  $key
     * @return $this
     */
    public function by($key)
    {
        $this->key = $key;

        return $this;
    }

    /**
     * Set the callback that should generate the response when the limit is exceeded.
     *
     * @param  callable  $callback
     * @return $this
     */
    public function response(callable $callback)
    {
        $this->responseCallback = $callback;

        return $this;
    }
}