\Pop\Http\ServerRequest

__construct()

__construct(string  $uri = null, string  $basePath = null, mixed  $filters = null, mixed  $streamToFile = null) 

Constructor

Instantiate the request object

Parameters

filter()

filter(mixed  $values) : array

Filter values

Parameters

Returns

addFilter()

addFilter(mixed  $filter) : \Pop\Filter\FilterableTrait

Add filter

Parameters

Throws

\InvalidArgumentException

Returns

addFilters()

addFilters(array  $filters) : \Pop\Filter\FilterableTrait

Add filters

Parameters

Returns

hasFilters()

hasFilters() : boolean

Has filters

Returns

getFilters()

getFilters() : array

Get filters

Returns

clearFilters()

clearFilters() : \Pop\Filter\FilterableTrait

Clear filters

Returns

filterAll()

filterAll(array  $values) : array

Filter all values, ignoring excludes

Parameters

Returns

addHeader()

addHeader(\Pop\Mime\Part\Header|string  $header, string  $value = null) : \Pop\Http\AbstractHttp

Add a header

Parameters

Returns

addHeaders()

addHeaders(array  $headers) : \Pop\Http\AbstractHttp

Add all headers

Parameters

Returns

getHeader()

getHeader(string  $name) : mixed

Get a header

Parameters

Returns

getHeaderValue()

getHeaderValue(string  $name) : mixed

Get header value

Parameters

Returns

getHeaders()

getHeaders() : array

Get all headers

Returns

getHeadersAsArray()

getHeadersAsArray() : array

Get all header values as associative array

Returns

getHeadersAsString()

getHeadersAsString(string  $status = null, string  $eol = "\r\n") : string

Get all header values formatted string

Parameters

Returns

hasHeaders()

hasHeaders() : boolean

Determine if there are headers

Returns

hasHeader()

hasHeader(string  $name) : boolean

Has a header

Parameters

Returns

removeHeader()

removeHeader(string  $name) : \Pop\Http\AbstractHttp

Remove a header

Parameters

Returns

removeHeaders()

removeHeaders() : \Pop\Http\AbstractHttp

Remove all headers

Returns

setBody()

setBody(string|\Pop\Mime\Part\Body  $body) : \Pop\Http\AbstractHttp

Set the body

Parameters

Returns

getBody()

getBody() : \Pop\Mime\Part\Body

Get the body

Returns

getBodyContent()

getBodyContent() : mixed

Get body content

Returns

hasBody()

hasBody() : boolean

Has a body

Returns

hasBodyContent()

hasBodyContent() : boolean

Has body content

Returns

decodeBodyContent()

decodeBodyContent(string  $body = null) : \Pop\Mime\Part\Body

Decode the body

Parameters

Returns

removeBody()

removeBody() : \Pop\Http\AbstractHttp

Remove the body

Returns

__get()

__get(string  $name) : mixed

Magic method to get a value from one of the server/environment variables

Parameters

Returns

isGet()

isGet() : boolean

Return whether or not the method is GET

Returns

isHead()

isHead() : boolean

Return whether or not the method is HEAD

Returns

isPost()

isPost() : boolean

Return whether or not the method is POST

Returns

isPut()

isPut() : boolean

Return whether or not the method is PUT

Returns

isDelete()

isDelete() : boolean

Return whether or not the method is DELETE

Returns

isTrace()

isTrace() : boolean

Return whether or not the method is TRACE

Returns

isOptions()

isOptions() : boolean

Return whether or not the method is OPTIONS

Returns

isConnect()

isConnect() : boolean

Return whether or not the method is CONNECT

Returns

isPatch()

isPatch() : boolean

Return whether or not the method is PATCH

Returns

isSecure()

isSecure() : boolean

Return whether or not the request is secure

Returns

getDocumentRoot()

getDocumentRoot() : string

Get the document root

Returns

getMethod()

getMethod() : string

Get the method

Returns

getPort()

getPort() : string

Get the server port

Returns

getScheme()

getScheme() : string

Get scheme

Returns

getHost()

getHost() : string

Get host without port)

Returns

getFullHost()

getFullHost() : string

Get host with port

Returns

getIp()

getIp(boolean  $proxy = true) : string

Get client's IP

Parameters

Returns

getCookie()

getCookie(string  $key = null) : string|array

Get a value from $_COOKIE, or the whole array

Parameters

Returns

getServer()

getServer(string  $key = null) : string|array

Get a value from $_SERVER, or the whole array

Parameters

Returns

getEnv()

getEnv(string  $key = null) : string|array

Get a value from $_ENV, or the whole array

Parameters

Returns

getBasePath()

getBasePath() : string

Get the base path

Returns

getRequestUri()

getRequestUri() : string

Get the request URI

Returns

getFullRequestUri()

getFullRequestUri() : string

Get the full request URI, including base path

Returns

getSegment()

getSegment(integer  $i) : string

Get a path segment, divided by the forward slash, where $i refers to the array key index, i.e., 0 1 2 /hello/world/page

Parameters

Returns

getSegments()

getSegments() : array

Get all path segments

Returns

setBasePath()

setBasePath(string  $path = null) : \Pop\Http\Server\Request

Set the base path

Parameters

Returns

hasFiles()

hasFiles() : boolean

Return whether or not the request has FILES

Returns

getQuery()

getQuery(string  $key = null) : string|array

Get a value from $_GET, or the whole array

Parameters

Returns

getPost()

getPost(string  $key = null) : string|array

Get a value from $_POST, or the whole array

Parameters

Returns

getFiles()

getFiles(string  $key = null) : string|array

Get a value from $_FILES, or the whole array

Parameters

Returns

getPut()

getPut(string  $key = null) : string|array

Get a value from PUT query data, or the whole array

Parameters

Returns

getPatch()

getPatch(string  $key = null) : string|array

Get a value from PATCH query data, or the whole array

Parameters

Returns

getDelete()

getDelete(string  $key = null) : string|array

Get a value from DELETE query data, or the whole array

Parameters

Returns

getQueryData()

getQueryData(string  $key = null) : string|array

Get a value from query data, or the whole array

Parameters

Returns

hasQueryData()

hasQueryData() : boolean

Has query data

Returns

getParsedData()

getParsedData(string  $key = null) : string|array

Get a value from parsed data, or the whole array

Parameters

Returns

hasParsedData()

hasParsedData() : boolean

Has parsed data

Returns

getRawData()

getRawData() : string

Get the raw data

Returns

hasRawData()

hasRawData() : boolean

Has raw data

Returns

getRequestUriObject()

getRequestUriObject() : \Pop\Http\Server\Request\Uri

Get request URI object

Returns

getRequestDataObject()

getRequestDataObject() : \Pop\Http\Server\Request\Data

Get request data object

Returns