\Orpheus\InputController\HTTPControllerRedirectHTTPResponse

The RedirectHTTPResponse class

Summary

Methods
Properties
Constants
run()
process()
collectFrom()
getCode()
setCode()
setControllerOutput()
getControllerOutput()
__toString()
generateFromException()
generateFromUserException()
__construct()
setPermanent()
getDestinationURI()
setDestinationURI()
No public properties found
No constants found
No protected methods found
$code
$controllerOutput
$destinationURI
N/A
No private methods found
No private properties found
N/A

Properties

$code

$code : integer

The HTTP response code

Type

integer

$controllerOutput

$controllerOutput : string

The output of the controller when running it

Type

string

$destinationURI

$destinationURI : string

The destination URI to redirect client

Type

string

Methods

run()

run() 

Process response to client

process()

process() 

Process the response

collectFrom()

collectFrom(string  $layout, array  $values = array()) : NULL

Collect response data from parameters

Parameters

string $layout
array $values

Returns

NULL

getCode()

getCode() : integer

Get the code

Returns

integer

setControllerOutput()

setControllerOutput(string  $controllerOutput) 

Set the controller output

Parameters

string $controllerOutput

getControllerOutput()

getControllerOutput() : string

Get the controller output

Returns

string

__toString()

__toString() : string

Get this response as string

Returns

string

generateFromException()

generateFromException(\Orpheus\InputController\Exception  $exception, string  $action = null) : \Orpheus\InputController\OutputResponse

Generate OutputResponse from Exception

Parameters

\Orpheus\InputController\Exception $exception
string $action

Returns

\Orpheus\InputController\OutputResponse

__construct()

__construct(string  $destinationURI) 

Constructor

Parameters

string $destinationURI

setPermanent()

setPermanent() 

Set this redirection permanent

getDestinationURI()

getDestinationURI() : string

Get the destination URI

Returns

string