TooManyRequestsHttpException.php 1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\web;

/**
11
 * TooManyRequestsHttpException represents a "Too Many Requests" HTTP exception with status code 429
12
 *
13 14 15 16 17
 * Use this exception to indicate that a client has made too many requests in a
 * given period of time. For example, you would throw this exception when
 * 'throttling' an API user.
 *
 * @link http://tools.ietf.org/search/rfc6585#section-4
18 19 20 21 22
 * @author Dan Schmidt <danschmidt5189@gmail.com>
 * @since 2.0
 */
class TooManyRequestsHttpException extends HttpException
{
23 24
    /**
     * Constructor.
25 26
     * @param string $message error message
     * @param integer $code error code
27 28 29 30 31 32
     * @param \Exception $previous The previous exception used for the exception chaining.
     */
    public function __construct($message = null, $code = 0, \Exception $previous = null)
    {
        parent::__construct(429, $message, $code, $previous);
    }
33
}