Yaf_Request_Abstract

abstract class Yaf_Request_Abstract (View source)

Constants

SCHEME_HTTP

SCHEME_HTTPS

Properties

string $module
string $controller
string $action
string $method
protected array $params
protected string $language
protected Yaf_Exception $_exception
protected string $_base_uri
protected string $uri
protected string $dispatched
protected string $routed

Methods

bool
isGet()

No description

bool
isDelete()

No description

bool
isPatch()

No description

string|null
getRaw()

No description

Yaf_Request_Abstract|null
clearParams()

No description

bool
isPost()

No description

bool
isPut()

No description

bool
isHead()

No description

bool
isOptions()

No description

bool
isCli()

No description

bool
isDispatched()

No description

bool
isRouted()

No description

bool
isXmlHttpRequest()

No description

mixed
getServer(string $name = null, string $default = null)

Retrieve $_SERVER variable

mixed
getEnv(string $name = null, string $default = null)

Retrieve $_ENV variable

mixed
getParam(string $name, mixed $default = '')

No description

array
getParams()

No description

Yaf_Exception
getException()

No description

string
getModuleName()

No description

string
getControllerName()

No description

string
getActionName()

No description

Yaf_Request_Abstract|bool|null
setParam(string|array $name, string $value = null)

No description

Yaf_Request_Abstract|bool
setModuleName(string $module, bool $format_name = true)

No description

Yaf_Request_Abstract|bool
setControllerName(string $controller, bool $format_name = true)

No description

Yaf_Request_Abstract|bool
setActionName(string $action, bool $format_name = true)

No description

string
getMethod()

No description

string
getLanguage()

No description

bool
setBaseUri(string $uri)

Set base URI, base URI is used when doing routing, in routing phase request URI is used to route a request, while base URI is used to skip the leading part(base URI) of request URI. That is, if comes a request with request URI a/b/c, then if you set base URI to "a/b", only "/c" will be used in routing phase.


Note:

generally, you don't need to set this, Yaf will determine it automatically.

string
getBaseUri()

No description

string
getRequestUri()

No description

Yaf_Request_Abstract|null
setRequestUri(string $uri)

No description

Yaf_Request_Abstract|null
setDispatched(bool $dispatched = null)

Set request as dispatched

Yaf_Request_Abstract|null
setRouted(bool $flag = null)

Set request as routed

mixed
get(string $name = null, mixed $default = null)

No description

mixed
getFiles(string $name = null, mixed $default = null)

No description

mixed
getCookie(string $name = null, mixed $default = null)

No description

mixed
getPost(string $name = '', mixed $default = null)

No description

mixed
getRequest(string $name = null, mixed $default = null)

No description

mixed
getQuery(string $name = null, mixed $default = null)

No description

Details

at line 1545
bool isGet()

No description

Return Value

bool

at line 1548
bool isDelete()

No description

Return Value

bool

at line 1551
bool isPatch()

No description

Return Value

bool

at line 1554
string|null getRaw()

No description

Return Value

string|null

at line 1559
Yaf_Request_Abstract|null clearParams()

No description

Return Value

Yaf_Request_Abstract|null

at line 1566
bool isPost()

No description

Return Value

bool

at line 1573
bool isPut()

No description

Return Value

bool

at line 1580
bool isHead()

No description

Return Value

bool

at line 1587
bool isOptions()

No description

Return Value

bool

at line 1594
bool isCli()

No description

Return Value

bool

at line 1601
final bool isDispatched()

No description

Return Value

bool

at line 1608
final bool isRouted()

No description

Return Value

bool

at line 1615
bool isXmlHttpRequest()

No description

Return Value

bool

at line 1627
mixed getServer(string $name = null, string $default = null)

Retrieve $_SERVER variable

Parameters

string $name

the variable name, if not provided returns all
string $default

if this parameter is provide, this will be returned if the variable can not be found

Return Value

mixed

at line 1639
mixed getEnv(string $name = null, string $default = null)

Retrieve $_ENV variable

Parameters

string $name

the variable name, if not provided returns all
string $default

if this parameter is provide, this will be returned if the variable can not be found

Return Value

mixed

at line 1649
mixed getParam(string $name, mixed $default = '')

No description

Parameters

string $name
mixed $default

Return Value

mixed

at line 1656
array getParams()

No description

Return Value

array

at line 1663
Yaf_Exception getException()

No description

Return Value

Yaf_Exception

at line 1670
string getModuleName()

No description

Return Value

string

at line 1677
string getControllerName()

No description

Return Value

string

at line 1684
string getActionName()

No description

Return Value

string

at line 1694
Yaf_Request_Abstract|bool|null setParam(string|array $name, string $value = null)

No description

Parameters

string|array $name

the variable name, or an array of key=>value pairs
string $value

Return Value

Yaf_Request_Abstract|bool|null

at line 1704
Yaf_Request_Abstract|bool setModuleName(string $module, bool $format_name = true)

No description

Parameters

string $module
bool $format_name

Return Value

Yaf_Request_Abstract|bool

at line 1714
Yaf_Request_Abstract|bool setControllerName(string $controller, bool $format_name = true)

No description

Parameters

string $controller
bool $format_name

Return Value

Yaf_Request_Abstract|bool

at line 1724
Yaf_Request_Abstract|bool setActionName(string $action, bool $format_name = true)

No description

Parameters

string $action
bool $format_name

Return Value

Yaf_Request_Abstract|bool

at line 1731
string getMethod()

No description

Return Value

string

at line 1738
string getLanguage()

No description

Return Value

string

at line 1752
bool setBaseUri(string $uri)

Set base URI, base URI is used when doing routing, in routing phase request URI is used to route a request, while base URI is used to skip the leading part(base URI) of request URI. That is, if comes a request with request URI a/b/c, then if you set base URI to "a/b", only "/c" will be used in routing phase.


Note:

generally, you don't need to set this, Yaf will determine it automatically.

Parameters

string $uri

base URI

Return Value

bool

at line 1759
string getBaseUri()

No description

Return Value

string

at line 1766
string getRequestUri()

No description

Return Value

string

at line 1775
Yaf_Request_Abstract|null setRequestUri(string $uri)

Since: 2.1.0

No description

Parameters

string $uri

request URI

Return Value

Yaf_Request_Abstract|null

at line 1784
final Yaf_Request_Abstract|null setDispatched(bool $dispatched = null)

Set request as dispatched

Parameters

bool $dispatched

Return Value

Yaf_Request_Abstract|null

at line 1793
final Yaf_Request_Abstract|null setRouted(bool $flag = null)

Set request as routed

Parameters

bool $flag

Return Value

Yaf_Request_Abstract|null

at line 1800
mixed get(string $name = null, mixed $default = null)

No description

Parameters

string $name
mixed $default

Return Value

mixed

at line 1807
mixed getFiles(string $name = null, mixed $default = null)

No description

Parameters

string $name
mixed $default

Return Value

mixed

at line 1814
mixed getCookie(string $name = null, mixed $default = null)

No description

Parameters

string $name
mixed $default

Return Value

mixed

at line 1821
mixed getPost(string $name = '', mixed $default = null)

No description

Parameters

string $name
mixed $default

Return Value

mixed

at line 1828
mixed getRequest(string $name = null, mixed $default = null)

No description

Parameters

string $name
mixed $default

Return Value

mixed

at line 1835
mixed getQuery(string $name = null, mixed $default = null)

No description

Parameters

string $name
mixed $default

Return Value

mixed