yiisoft/yii2

View on GitHub
framework/web/RangeNotSatisfiableHttpException.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

/**
 * @link https://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license https://www.yiiframework.com/license/
 */

namespace yii\web;

/**
 * RangeNotSatisfiableHttpException represents an exception caused by an improper request of the end-user.
 * This exception thrown when the requested range is not satisfiable: the client asked for a portion of
 * the file (byte serving), but the server cannot supply that portion. For example, if the client asked for
 * a part of the file that lies beyond the end of the file.
 *
 * Throwing an RangeNotSatisfiableHttpException like in the following example will result in the error page
 * with error 416 to be displayed.
 *
 * @author Zalatov Alexander <CaHbKa.Z@gmail.com>
 *
 * @since 2.0.11
 */
class RangeNotSatisfiableHttpException extends HttpException
{
    /**
     * Constructor.
     * @param string|null $message error message
     * @param int $code error code
     * @param \Throwable|null $previous The previous exception used for the exception chaining.
     */
    public function __construct($message = null, $code = 0, $previous = null)
    {
        parent::__construct(416, $message, $code, $previous);
    }
}