Docs For Class TinyMVCHttpRequest

Description

Standard HTTP request handler, with session and cookie support

Located in /lib/TinyMVCHttpRequest.class.php (line 15)

TinyMVCRequest
   |
   --TinyMVCHttpRequest

Method Summary

static TinyMVCHttpRequest getInstance ()

void __destruct ()

mixed getCookieParam (string $key, [mixed $nullValue = null])

array getCookies ()

string getRemoteAddr ()

string getRequestUri ()

string getServerName ()

void sessionRegister ( $key, $value)

void sessionUnregister (string $key)

void setCookieParam (string $key, string $value)

void setSessionParam (string $key, mixed $value)

Variables

Inherited Variables

Inherited from TinyMVCRequest

TinyMVCRequest::$instance
TinyMVCRequest::$paramArray
TinyMVCRequest::$sessionArray

Methods

static getInstance (line 37)

get instance of class

return: request object
access: public

static TinyMVCHttpRequest getInstance ()

Redefinition of:

TinyMVCRequest::getInstance(): get instance of request class

Destructor __destruct (line 48)

Destructor

access: public

void __destruct ()

getCookieParam (line 58)

get cookie parameter value by given key

return: parameter value
access: public

mixed getCookieParam (string $key, [mixed $nullValue = null])

string $key: parameter key
mixed $nullValue: return value for non-existent key

getCookies (line 126)

get all cookies

return: key => value cookie parameters array
access: public

array getCookies ()

getRemoteAddr (line 118)

get client's remote address

access: public

string getRemoteAddr ()

getRequestUri (line 110)

get request URI

access: public

string getRequestUri ()

getServerName (line 102)

get server name

access: public

string getServerName ()

sessionRegister (line 85)

Alias of setSessionParam

access: public

void sessionRegister ( $key, $value)

$key
$value

sessionUnregister (line 93)

remove session parameter by key

access: public

void sessionUnregister (string $key)

string $key: session key

Redefinition of:

TinyMVCRequest::sessionUnregister(): remove session parameter by key

setCookieParam (line 67)

set cookie parameter value

access: public

void setCookieParam (string $key, string $value)

string $key: parameter key
string $value: parameter value

setSessionParam (line 77)

set session parameter

access: public

void setSessionParam (string $key, mixed $value)

string $key: session key
mixed $value: session value

Redefinition of:

TinyMVCRequest::setSessionParam(): set session parameter

Inherited Methods

Inherited From TinyMVCRequest

TinyMVCRequest::getInstance()
TinyMVCRequest::getParam()
TinyMVCRequest::getParams()
TinyMVCRequest::getSessionParam()
TinyMVCRequest::getSessions()
TinyMVCRequest::isSessionRegistered()
TinyMVCRequest::sessionUnregister()
TinyMVCRequest::setParam()
TinyMVCRequest::setSessionParam()