Docs For Class TinyMVCRequest

Description

Request abstract class

abstract:

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

Direct descendents

Class	Description
TinyMVCHttpRequest	Standard HTTP request handler, with session and cookie support

Variable Summary

static mixed $instance

mixed $paramArray

mixed $sessionArray

Method Summary

static TinyMVCRequest getInstance ()

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

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

array getParams ()

array getSessions ()

bool isSessionRegistered (string $key)

void sessionUnregister (string $key)

void setParam (string $key, mixed $value)

void setSessionParam (string $key, mixed $value)

Variables

static mixed $instance = null (line 18)

access: protected

mixed $paramArray (line 16)

access: protected

mixed $sessionArray (line 17)

access: protected

Methods

static getInstance (line 30)

get instance of request class

abstract:
access: public

static TinyMVCRequest getInstance ()

Redefined in descendants as:

TinyMVCHttpRequest::getInstance() : get instance of class

static getSessionParam (line 57)

get session parameter value by given key

return: session value
access: public

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

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

getParam (line 38)

get parameter value by given key

return: parametr value
access: public

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

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

getParams (line 91)

get all parameters

return: key => value parameters array
access: public

array getParams ()

getSessions (line 99)

get all sessions

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

array getSessions ()

isSessionRegistered (line 66)

check whether or not session is registered

access: public

bool isSessionRegistered (string $key)

string $key: session key

sessionUnregister (line 83)

remove session parameter by key

access: public

void sessionUnregister (string $key)

string $key: session key

Redefined in descendants as:

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

setParam (line 47)

set parameter value

access: public

void setParam (string $key, mixed $value)

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

setSessionParam (line 75)

set session parameter

access: public

void setSessionParam (string $key, mixed $value)

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

Redefined in descendants as:

TinyMVCHttpRequest::setSessionParam() : set session parameter