API Documentation
Back to top  

Request

Class Rest_Request Holds the Request in a RestServer

Methods

Constructor of Rest\Request

__construct(\Rest\Rest\Server $rest = null)

Arguments

$rest

\Rest\Rest\Server

= null, Parent Rest\Server

Return Rest\Server used

getRest() : \Rest\Rest\Server

Response

\Rest\Rest\Server

Returns if Request is GET

isGet() : boolean

Response

boolean

Returns if Request is POST

isPost() : boolean

Response

boolean

Return if Request is PUT

isPut() : boolean

Response

boolean

Return true if Request is DELETE

isDelete() : boolean

Response

boolean

Get parameters sent with GET (url parameters)

getGet(mixed $k = null) : mixed

Arguments

$k

mixed

get[$key]

Response

mixed

Return parameters sent on a POST

getPost(mixed $k = null) : mixed

Arguments

$k

mixed

post[$key]

Response

mixed

Return FILES sent on a POST

getFiles(mixed $k = null) : mixed

Arguments

$k

mixed

file[$key]

Response

mixed

Return content sent with PUT

getPut(mixed $k = null) : mixed

Arguments

$k

mixed

Response

mixed

Return content sent with PUT

getInput() : mixed

Response

mixed

Return request BODY

getBody() : string

Response

string

Return Request Method(PUT, DELETE, OPTION, GET.

getMethod() : string

..)

Response

string

Return value of http header

getHeader(string $k) : string

Arguments

$k

string

Response

string

Return E-tag/if-match requested

getETag() : string

Response

string

Set request method

setMethod(string $method) : \Rest\Rest\Request

Arguments

$method

string

Response

\Rest\Rest\Request

Return the URI requested

getRequestURI() : string

Response

string

Return part of the URL

getParameter(int $i) : string

Arguments

$i

int

part of the uri

Response

string

Return the URI or part of it

getURI(int $i = null) : string

Arguments

$i

int

part of the uri

Response

string

Sets the URI to deal

setURI(string $uri) : \Rest\Rest\Request

Arguments

$uri

string

Response

\Rest\Rest\Request

Return the extension of the URI (if any)

getExtension() : string

Response

string

Return true if given mime is accepted

acceptMime(string $mime) : boolean

Arguments

$mime

string

to check

Response

boolean

getSession

getSession($k)

Arguments

$k

setSession

setSession($k, $v)

Arguments

$k

$v

getCookie

getCookie($k)

Arguments

$k

setCookie

setCookie($k, $v)

Arguments

$k

$v

Properties

rest

rest

requestURI

requestURI

URIParts

URIParts

requestMethod

requestMethod

get

get

post

post

files

files

headers

headers