Elgg
Version master
|
Download response builder. More...
Public Member Functions | ||||||
getHeaders () | ||||||
Returns additional response headers.
| ||||||
setForwardURL (string $forward_url=REFERRER) | ||||||
Sets redirect URL.
| ||||||
setFilename (string $filename= '', bool $inline=false) | ||||||
Set the filename for the download. More... | ||||||
Public Member Functions inherited from Elgg\Http\OkResponse | ||||||
__construct ($content= '', int $status_code=ELGG_HTTP_OK, string $forward_url=null) | ||||||
Constructor. More... | ||||||
Public Member Functions inherited from Elgg\Http\Response | ||||||
setContent ($content= '') | ||||||
{Sets response body.
| ||||||
getContent () | ||||||
{Returns response body.
| ||||||
setException (\Exception $e) | ||||||
{Set an exception for this response.
| ||||||
getException () | ||||||
{Get the exception for this reponse.
| ||||||
setStatusCode (int $status_code) | ||||||
{Sets response HTTP status code.
| ||||||
getStatusCode () | ||||||
{Returns status code.
| ||||||
setForwardURL (string $forward_url=REFERRER) | ||||||
{Sets redirect URL.
| ||||||
getForwardURL () | ||||||
{Returns redirect URL.
| ||||||
setHeaders (array $headers=[]) | ||||||
{Sets additional response headers.
| ||||||
getHeaders () | ||||||
{Returns additional response headers.
| ||||||
isInformational () | ||||||
{Check if response is informational.
| ||||||
isSuccessful () | ||||||
{Check if response is successful.
| ||||||
isOk () | ||||||
{Check if response is OK.
| ||||||
isRedirection () | ||||||
{Check if response is redirection.
| ||||||
isClientError () | ||||||
{Check if response is client error.
| ||||||
isServerError () | ||||||
{Check if response is server error.
| ||||||
isNotModified () | ||||||
{Check if response has been modified.
| ||||||
Additional Inherited Members | |
Protected Attributes inherited from Elgg\Http\Response | |
$content | |
int | $status_code |
string | $forward_url = null |
array | $headers = [] |
Exception | $exception = null |
bool | $secure_forward_url = true |
Elgg\Http\DownloadResponse::getHeaders | ( | ) |
Returns additional response headers.
Implements Elgg\Http\ResponseBuilder.
Definition at line 15 of file DownloadResponse.php.
Elgg\Http\DownloadResponse::setFilename | ( | string | $filename = '' , |
bool | $inline = false |
||
) |
Set the filename for the download.
This will only be applied if the 'Content-Disposition' header isn't already set
string | $filename | The filename when downloaded |
bool | $inline | Is this an inline download (default: false, determines the 'Content-Disposition' header) |
Definition at line 54 of file DownloadResponse.php.
Elgg\Http\DownloadResponse::setForwardURL | ( | string | $forward_url = REFERRER | ) |
Sets redirect URL.
string | $forward_url | Forward URL |
InvalidArgumentException |
Implements Elgg\Http\ResponseBuilder.
Definition at line 40 of file DownloadResponse.php.