PHP Class ManaPHP\Http\Response

Inheritance: extends ManaPHP\Component, implements ManaPHP\Http\ResponseInterface

Datei anzeigen Open project: manaphp/manaphp

Protected Properties

Property	Type	Description
$_content	string
$_file	string
$_headers	array
$_sent	boolean

Public Methods

Method	Description
appendContent ( string $content ) : static	Appends a string to the HTTP response body
getContent ( ) : string	Gets the HTTP response body
getHeaders ( ) : array
isSent ( ) : boolean	Check if the response is already sent
redirect ( string \| array $location, boolean $temporarily = true ) : static	Redirect by HTTP to another action or URL `Using a string redirect (internal/external) $response->redirect("posts/index"); $response->redirect("http://www.google.com"); $response->redirect("http://www.example.com/new-location", false);`
send ( ) : static	Prints out HTTP response to the client
sendHeaders ( ) : static	Sends headers to the client
setAttachment ( string $attachmentName ) : static
setContent ( string $content ) : static	Sets HTTP response body `$response->setContent("Hello!");`
setContentType ( string $contentType, string $charset = null ) : static	Sets the response content-type mime, optionally the charset `$response->setContentType('application/pdf'); $response->setContentType('text/plain', 'UTF-8');`
setCsvContent ( array $rows, string $attachmentName, array \| string $columns = null ) : static
setEtag ( string $etag ) : static	Set a custom ETag `$response->setEtag(md5(time()));`
setExpires ( integer $timestamp ) : static	Sets a Expires header to use HTTP cache `$this->response->setExpires(new DateTime());`
setFileToSend ( string $file, string $attachmentName = null ) : static	Sets an attached file to be sent at the end of the request
setHeader ( string $name, string $value ) : static	Overwrites a header in the response `$response->setHeader("Content-Type", "text/plain");`
setJsonContent ( array $content, integer $jsonOptions = null ) : static	Sets HTTP response body. The parameter is automatically converted to JSON `$response->setJsonContent(array("status" => "OK")); $response->setJsonContent(array("status" => "OK"), JSON_NUMERIC_CHECK);`
setNotModified ( ) : static	Sets a Not-Modified response
setRawHeader ( string $header ) : static	Send a raw header to the response `$response->setRawHeader("HTTP/1.1 404 Not Found");`
setStatusCode ( integer $code, string $message ) : static	Sets the HTTP response code `$response->setStatusCode(404, "Not Found");`

Method Details

appendContent() public method

Appends a string to the HTTP response body

public appendContent ( string $content ) : static
$content	string
return	static

getContent() public method

Gets the HTTP response body

public getContent ( ) : string
return	string

getHeaders() public method

public getHeaders ( ) : array
return	array

isSent() public method

Check if the response is already sent

public isSent ( ) : boolean
return	boolean

redirect() public method

Redirect by HTTP to another action or URL


Using a string redirect (internal/external)
   $response->redirect("posts/index");
   $response->redirect("http://www.google.com");
   $response->redirect("http://www.example.com/new-location", false);

public redirect ( string \| array $location, boolean $temporarily = true ) : static
$location	string \| array
$temporarily	boolean
return	static

send() public method

Prints out HTTP response to the client

public send ( ) : static
return	static

sendHeaders() public method

Sends headers to the client

public sendHeaders ( ) : static
return	static

setAttachment() public method

public setAttachment ( string $attachmentName ) : static
$attachmentName	string
return	static

setContent() public method

Sets HTTP response body


   $response->setContent("Hello!");

public setContent ( string $content ) : static
$content	string
return	static

setContentType() public method

Sets the response content-type mime, optionally the charset


   $response->setContentType('application/pdf');
   $response->setContentType('text/plain', 'UTF-8');

public setContentType ( string $contentType, string $charset = null ) : static
$contentType	string
$charset	string
return	static

setCsvContent() public method

public setCsvContent ( array $rows, string $attachmentName, array \| string $columns = null ) : static
$rows	array
$attachmentName	string
$columns	array \| string
return	static

setEtag() public method

Set a custom ETag


   $response->setEtag(md5(time()));

public setEtag ( string $etag ) : static
$etag	string
return	static

setExpires() public method

Sets a Expires header to use HTTP cache


   $this->response->setExpires(new DateTime());

public setExpires ( integer $timestamp ) : static
$timestamp	integer
return	static

setFileToSend() public method

Sets an attached file to be sent at the end of the request

public setFileToSend ( string $file, string $attachmentName = null ) : static
$file	string
$attachmentName	string
return	static

setHeader() public method

Overwrites a header in the response


   $response->setHeader("Content-Type", "text/plain");

public setHeader ( string $name, string $value ) : static
$name	string
$value	string
return	static

setJsonContent() public method

Sets HTTP response body. The parameter is automatically converted to JSON


   $response->setJsonContent(array("status" => "OK"));
   $response->setJsonContent(array("status" => "OK"), JSON_NUMERIC_CHECK);

public setJsonContent ( array $content, integer $jsonOptions = null ) : static
$content	array
$jsonOptions	integer	consisting on http://www.php.net/manual/en/json.constants.php
return	static

setNotModified() public method

Sets a Not-Modified response

public setNotModified ( ) : static
return	static

setRawHeader() public method

Send a raw header to the response


   $response->setRawHeader("HTTP/1.1 404 Not Found");

public setRawHeader ( string $header ) : static
$header	string
return	static

setStatusCode() public method

Sets the HTTP response code


   $response->setStatusCode(404, "Not Found");

public setStatusCode ( integer $code, string $message ) : static
$code	integer
$message	string
return	static

Property Details

$_content protected_oe property

protected string $_content
return	string

$_file protected_oe property

protected string $_file
return	string

$_headers protected_oe property

protected array $_headers
return	array

$_sent protected_oe property

protected bool $_sent
return	boolean