PHP Interface Elgg\Http\ResponseBuilder

Public Methods

Method	Description
getContent ( ) : mixed	Returns response body
getForwardURL ( ) : string	Returns redirect URL
getHeaders ( ) : array	Returns additional response headers
getStatusCode ( ) : integer	Returns status code
isClientError ( ) : boolean	Check if response is client error
isInformational ( ) : boolean	Check if response is informational
isNotModified ( ) : boolean	Check if response has been modified
isOk ( ) : boolean	Check if response is OK
isRedirection ( ) : boolean	Check if response is redirection
isServerError ( ) : boolean	Check if response is server error
isSuccessful ( ) : boolean	Check if response is successful
setContent ( mixed $content = '' ) : self	Sets response body
setForwardURL ( string $forward_url = REFERRER ) : self	Sets redirect URL
setHeaders ( array $headers = [] ) : self	Sets additional response headers
setStatusCode ( integer $status_code = ELGG_HTTP_OK ) : self	Sets response HTTP status code

Returns response body

public getContent ( ) : mixed
return	mixed

Returns redirect URL

public getForwardURL ( ) : string
return	string

Returns additional response headers

public getHeaders ( ) : array
return	array

Returns status code

public getStatusCode ( ) : integer
return	integer

Check if response is client error

public isClientError ( ) : boolean
return	boolean

Check if response is informational

public isInformational ( ) : boolean
return	boolean

Check if response has been modified

public isNotModified ( ) : boolean
return	boolean

Check if response is OK

public isOk ( ) : boolean
return	boolean

Check if response is redirection

public isRedirection ( ) : boolean
return	boolean

Check if response is server error

public isServerError ( ) : boolean
return	boolean

Check if response is successful

public isSuccessful ( ) : boolean
return	boolean

Sets response body

public setContent ( mixed $content = '' ) : self
$content	mixed	Content of the response as a scalar value or an array
return	self

Sets redirect URL

public setForwardURL ( string $forward_url = REFERRER ) : self
$forward_url	string	Forward URL
return	self

Sets additional response headers

public setHeaders ( array $headers = [] ) : self
$headers	array	Headers
return	self

Sets response HTTP status code

public setStatusCode ( integer $status_code = ELGG_HTTP_OK ) : self
$status_code	integer	Status code
return	self