VuFind API Documentation

HttpDownloadException extends Exception
in package
implements HttpStatusInterface

"Format Unavailable" Exception

Tags
category

VuFind

author

Mario Trojan mario.trojan@uni-tuebingen.de

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

Interfaces, Classes, Traits and Enums

HttpStatusInterface
Interface for exceptions that should trigger specific HTTP status codes when unhandled.

Table of Contents

$responseBody  : string|null
HTTP response body associated with this exception.
$responseHeaders  : Headers|null
HTTP response headers associated with this exception.
$statusCode  : int|null
HTTP status associated with this exception.
$url  : string
URL we tried to download.
__construct()  : mixed
Constructor
getHttpStatus()  : int|null
Get HTTP status associated with this exception.
getResponseBody()  : string|null
Get HTTP response body.
getResponseHeaders()  : Headers|null
Get HTTP response headers.
getUrl()  : string
Get URL we tried to download.

Properties

$responseBody

HTTP response body associated with this exception.

protected string|null $responseBody

$responseHeaders

HTTP response headers associated with this exception.

protected Headers|null $responseHeaders

Methods

__construct()

Constructor

public __construct(string $message, string $url[, int|null $statusCode = null ][, Headers|null $responseHeaders = null ][, string|null $responseBody = null ][, Throwable|null $previous = null ]) : mixed
Parameters
$message : string

Exception message

$url : string

URL we tried to download

$statusCode : int|null = null

HTTP status code

$responseHeaders : Headers|null = null

HTTP response headers

$responseBody : string|null = null

HTTP response body

$previous : Throwable|null = null

Previous exception

Return values
mixed

getHttpStatus()

Get HTTP status associated with this exception.

public getHttpStatus() : int|null
Return values
int|null

getResponseBody()

Get HTTP response body.

public getResponseBody() : string|null
Return values
string|null

getResponseHeaders()

Get HTTP response headers.

public getResponseHeaders() : Headers|null
Return values
Headers|null

Search results