Orpheus

HttpRequest extends InputRequest

in package

• orpheus

Table of Contents

Properties

$cookies  : array<string|int, mixed>

The cookies sent to this route

$defaultController  : HttpController|null

$domain  : string

The request host domain name

$files  : array<string|int, mixed>

The uploaded files sent to this route

$headers  : array<string|int, mixed>

The headers sent to this route

$input  : array<string|int, mixed>|string|null

The input (like stdin)

$inputType  : string

The input content type

$mainRequest  : static|null

The current main request

$method  : string

The used method for this request

$parameters  : array<string|int, mixed>

The input parameters (inline parameters)

$path  : string

The path

$pathValues  : array<string|int, mixed>

The values in path

$route  : ControllerRoute|null

The found route for this request A request could exist without any route (e.g. Route initialization failed)

$scheme  : string

The scheme used to access this route

Methods

__construct()  : mixed

Constructor

__toString()  : string

Get this request as string

cloneWithPath()  : InputRequest

Clone this request using another path (expecting a sub path)

findFirstMatchingRoute()  : array<string|int, mixed>

Find a matching route according to the request

formatUrl()  : string

Generate new URL for this request

generateFromEnvironment()  : HttpRequest

Generate HttpRequest from environment

getAllData()  : array<string|int, mixed>

Get all input data

getArrayData()  : mixed

Get the data by key with array as default

getConfigPostMaxSize()  : int

Get php config for max post size

getController()  : AbstractController

Get running controller

getCookies()  : array<string|int, mixed>

Get the cookies

getData()  : mixed

Get a data by $key, assuming $default

getDefaultController()  : HttpController

getDomain()  : string

Get the host domain

getFiles()  : array<string|int, mixed>

Get the uploaded files

getHeaderContentLength()  : int|null

Get the header Content-Length

getHeaders()  : array<string|int, mixed>

Get the headers

getInput()  : array<string|int, mixed>

Get input

getInputType()  : string

Get the input type

getInputValue()  : mixed

Get the input by $key, assuming $default value

getMainHttpRequest()  : HttpRequest|null

Get the main http request or null if not an HTTP request

getMainRequest()  : InputRequest|null

Get the main input request

getMainRequest()  : HttpRequest

Get the main input request

getMethod()  : string

Get the method

getOption()  : mixed

Get the option by $key, assuming $default value

getParameter()  : mixed

Get the parameter by $key, assuming $default value

getParameters()  : array<string|int, mixed>

Get all parameters

getPath()  : string

Get the path

getPathValue()  : string|null

Get path value by $key, assuming $default

getPathValues()  : array<string|int, mixed>

Get path values

getRoute()  : ControllerRoute|null

Get the route to this request

getRouteClass()  : string

Get the name of the route class associated to a HttpRequest

getRouteName()  : string

Get the route name to this request

getRoutes()  : array<string|int, HttpRoute>

Get all available routes

getScheme()  : string

Get the scheme

getUrl()  : string

Get the URL used for this request

handleCurrentRequest()  : void

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

hasArrayData()  : bool

Test if data $key is an array

hasData()  : bool

Test if data contains the $key

hasDataKey()  : bool

Test if path contains a value and return it as parameter

hasInput()  : bool

Test if request has any input

hasInputValue()  : bool

Test if input $key exists in this request

hasParameter()  : bool

Test if parameter $key exists in this request

hasPathValue()  : bool

Check request has path value $key

isDelete()  : bool

Test if this is a DELETE request

isGet()  : bool

Test if this is a GET request

isPost()  : bool

Test if this is a POST request

isPostSiteOverLimit()  : bool

Test incoming request is over php max post size

isPut()  : bool

Test if this is a PUT request

matchPath()  : string

Test path is matching regex

process()  : OutputResponse

Process the request by finding a route and processing it

processRoute()  : OutputResponse

Process the given route

redirect()  : RedirectHttpResponse|null

Redirect response to $route

setRoute()  : InputRequest

Set the route to this request

showFallbackError()  : void

setContent()  : HttpRequest

Set the content (input & input type)

setCookies()  : HttpRequest

Set the cookies

setDomain()  : $this

Set the host domain

setFiles()  : HttpRequest

Set the uploaded files

setHeaders()  : HttpRequest

Set the headers

setInput()  : InputRequest

Set the input

setInputType()  : HttpRequest

Set the input type

setMethod()  : HttpRequest

Set the method

setParameters()  : InputRequest

Set the parameters

setPath()  : InputRequest

Set the path

setScheme()  : HttpRequest

Set the scheme