\Orpheus\InputController\HTTPControllerHTTPRequest

__construct()

__construct(string  $method, string  $path, array  $parameters = null, array  $input = null) 

Constructor

Parameters

findFirstMatchingRoute()

findFirstMatchingRoute(boolean  $alternative = false) : \Orpheus\InputController\HTTPController\Route

Find a matching route according to the request

Parameters

Returns

redirect()

redirect(\Orpheus\InputController\ControllerRoute  $route) : \Orpheus\InputController\HTTPController\RedirectHTTPResponse

Redirect response to $route

Parameters

Returns

process()

process() : \Orpheus\InputController\OutputResponse

Process the request by finding a route and processing it

Returns

processRoute()

processRoute(\Orpheus\InputController\ControllerRoute  $route) : \Orpheus\InputController\OutputResponse

Process the given route

Parameters

Throws

\Orpheus\Exception\NotFoundException

Returns

getRoutes()

getRoutes() : array<mixed,\Orpheus\InputController\HTTPController\HTTPRoute>

Get all available routes

Returns

getPath()

getPath() : string

Get the path

Returns

getParameter()

getParameter(string  $key, mixed  $default = null) : mixed

Get the parameter by $key, assuming $default value

Parameters

Returns

hasParameter()

hasParameter(string  $key) : boolean

Test if parameter $key exists in this request

Parameters

Returns

getParameters()

getParameters() : array

Get all parameters

Returns

hasInput()

hasInput() : boolean

Test if request has any input

Returns

getInput()

getInput() : array

Get input

Returns

getInputValue()

getInputValue(string  $key, mixed  $default = null) : mixed

Get the input by $key, assuming $default value

Parameters

Returns

hasInputValue()

hasInputValue(string  $key) : boolean

Test if input $key exists in this request

Parameters

Returns

getMainRequest()

getMainRequest() : \Orpheus\InputController\InputRequest

Get the main input request

Returns

getRouteName()

getRouteName() : string

Get the route name to this request

Returns

getRoute()

getRoute() : \Orpheus\InputController\ControllerRoute

Get the route to this request

Returns

setRoute()

setRoute(\Orpheus\InputController\ControllerRoute  $route) : \Orpheus\InputController\InputRequest

Set the route to this request

Parameters

Returns

__toString()

__toString() : string

Get this request as string

Returns

getURL()

getURL() : string

Get the URL used for this request

Returns

generateFromEnvironment()

generateFromEnvironment() : \Orpheus\InputController\HTTPController\HTTPRequest

Generate HTTPRequest from environment

Returns

handleCurrentRequest()

handleCurrentRequest() 

Handle the current request as a HTTPRequest one This method ends the script

getRouteClass()

getRouteClass() : string

Get the name of the route class associated to a HTTPRequest

Returns

getMethod()

getMethod() : string

Get the method

Returns

isGET()

isGET() : boolean

Test if this is a GET request

Returns

isPOST()

isPOST() : boolean

Test if this is a POST request

Returns

isPUT()

isPUT() : boolean

Test if this is a PUT request

Returns

isDELETE()

isDELETE() : boolean

Test if this is a DELETE request

Returns

getScheme()

getScheme() : string

Get the scheme

Returns

getDomain()

getDomain() : string

Get the host domain

Returns

getHeaders()

getHeaders() : array

Get the headers

Returns

getInputType()

getInputType() : string

Get the input type

Returns

getCookies()

getCookies() : array

Get the cookies

Returns

getFiles()

getFiles() : array

Get the uploaded files

Returns

getAllData()

getAllData() : array

Get all input data

Returns

getData()

getData(string  $key, mixed  $default = null) : mixed

Get a data by $key, assuming $default

Parameters

Returns

getArrayData()

getArrayData(string  $key) : mixed

Get the data by key with array as default

Parameters

Returns

hasArrayData()

hasArrayData(string  $key = null) : boolean

Test if data $key is an array

Parameters

Returns

hasData()

hasData(string  $key = null) : boolean

Test if data contains the $key

Parameters

Returns

hasDataKey()

hasDataKey(string  $path = null, string  $value = null) : boolean

Test if path contains a value and return it as parameter

Parameters

Returns

getPathValues()

getPathValues() : \Orpheus\InputController\HTTPController\stdClass

Get path values

Returns

getPathValue()

getPathValue(string  $key, mixed  $default = null) : string

Get path value by $key, assuming $default

Parameters

Returns

The path value for $key

hasPathValue()

hasPathValue(string  $key) : boolean

Check request has path value $key

Parameters

Returns

True if it has the $key value in path

setPath()

setPath(string  $path) : \Orpheus\InputController\InputRequest

Set the path

Parameters

Returns

setParameters()

setParameters(array  $parameters) : \Orpheus\InputController\InputRequest

Set the parameters

Parameters

Returns

setInput()

setInput(array  $input) : \Orpheus\InputController\InputRequest

Set the input

Parameters

Returns

setMethod()

setMethod(string  $method) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the method

Parameters

Returns

setScheme()

setScheme(string  $scheme) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the scheme

Parameters

Returns

setDomain()

setDomain(string  $domain) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the host domain

Parameters

Returns

setHeaders()

setHeaders(array  $headers) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the headers

Parameters

Returns

setInputType()

setInputType(string  $inputType) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the input type

Parameters

Returns

setContent()

setContent(string  $content, string  $contentType) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the content (input & input type)

Parameters

Returns

setCookies()

setCookies(array  $cookies) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the cookies

Parameters

Returns

setFiles()

setFiles(array  $files) : \Orpheus\InputController\HTTPController\HTTPRequest

Set the uploaded files

Parameters

Returns