1. class
  2. Yaf
  3. \
  4. Request
  5. \
  6. Simple

Simple

class Simple extends Request_Abstract (View source)

\Yaf\Request\Simple is particularly used for test purpose. ie. simulate a spacial request under CLI mode.

Constants

SCHEME_HTTP

SCHEME_HTTPS

Properties

string $module from  Request_Abstract
string $controller from  Request_Abstract
string $action from  Request_Abstract
string $method from  Request_Abstract
protected array $params from  Request_Abstract
protected string $language from  Request_Abstract
protected Exception $_exception from  Request_Abstract
protected string $_base_uri from  Request_Abstract
protected string $uri from  Request_Abstract
protected string $dispatched from  Request_Abstract
protected string $routed from  Request_Abstract

Methods

bool
isGet()

No description

from  Request_Abstract
bool
isPost()

No description

from  Request_Abstract
bool
isPut()

No description

from  Request_Abstract
bool
isHead()

No description

from  Request_Abstract
bool
isOptions()

No description

from  Request_Abstract
bool
isCli()

No description

from  Request_Abstract
bool
isDispatched()

No description

from  Request_Abstract
bool
isRouted()

No description

from  Request_Abstract
bool
isXmlHttpRequest()

Check the request whether it is a Ajax Request

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

Retrieve $_SERVER variable

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

Retrieve $_ENV variable

from  Request_Abstract
mixed
getParam(string $name, mixed $default = null)

No description

from  Request_Abstract
array
getParams()

No description

from  Request_Abstract
Exception
getException()

No description

from  Request_Abstract
string
getModuleName()

No description

from  Request_Abstract
string
getControllerName()

No description

from  Request_Abstract
string
getActionName()

No description

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

No description

from  Request_Abstract
Request_Abstract|bool
setModuleName(string $module)

No description

from  Request_Abstract
Request_Abstract|bool
setControllerName(string $controller)

No description

from  Request_Abstract
Request_Abstract|bool
setActionName(string $action)

No description

from  Request_Abstract
string
getMethod()

No description

from  Request_Abstract
string
getLanguage()

No description

from  Request_Abstract
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.

from  Request_Abstract
string
getBaseUri()

No description

from  Request_Abstract
string
getRequestUri()

No description

from  Request_Abstract
setRequestUri(string $uri)

No description

from  Request_Abstract
bool
setDispatched()

Set request as dispatched

from  Request_Abstract
Request_Abstract|bool
setRouted()

Set request as routed

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

Retrieve $_GET variable

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

Retrieve $_REQUEST variable

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

Retrieve $_POST variable

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

Retrieve $_Cookie variable

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

No description

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

Retrieve variable from client, this method will search the name in $_REQUEST params, if the name is not found, then will search in $_POST, $_GET, $_COOKIE, $_SERVER

__construct(string $method, string $controller, string $action, string $params = null)

No description

Details

in Request_Abstract at line 1367
bool isGet()

No description

Return Value

bool

in Request_Abstract at line 1374
bool isPost()

No description

Return Value

bool

in Request_Abstract at line 1381
bool isPut()

No description

Return Value

bool

in Request_Abstract at line 1388
bool isHead()

No description

Return Value

bool

in Request_Abstract at line 1395
bool isOptions()

No description

Return Value

bool

in Request_Abstract at line 1402
bool isCli()

No description

Return Value

bool

in Request_Abstract at line 1409
bool isDispatched()

No description

Return Value

bool

in Request_Abstract at line 1416
bool isRouted()

No description

Return Value

bool

at line 2201
bool isXmlHttpRequest()

Check the request whether it is a Ajax Request


Note:

This method depends on the request header: HTTP_X_REQUESTED_WITH, some Javascript library doesn't set this header while doing Ajax request

Return Value

bool false

in Request_Abstract at line 1435
mixed getServer(string $name = null, mixed $default = null)

Retrieve $_SERVER variable

Parameters

string $name

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

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

Return Value

mixed

in Request_Abstract at line 1447
mixed getEnv(string $name = null, mixed $default = null)

Retrieve $_ENV variable

Parameters

string $name

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

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

Return Value

mixed

in Request_Abstract at line 1457
mixed getParam(string $name, mixed $default = null)

No description

Parameters

string $name
mixed $default

Return Value

mixed

in Request_Abstract at line 1464
array getParams()

No description

Return Value

array

in Request_Abstract at line 1471
Exception getException()

No description

Return Value

Exception

in Request_Abstract at line 1478
string getModuleName()

No description

Return Value

string

in Request_Abstract at line 1485
string getControllerName()

No description

Return Value

string

in Request_Abstract at line 1492
string getActionName()

No description

Return Value

string

in Request_Abstract at line 1502
Request_Abstract|bool 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

Request_Abstract|bool

in Request_Abstract at line 1511
Request_Abstract|bool setModuleName(string $module)

No description

Parameters

string $module

Return Value

Request_Abstract|bool

in Request_Abstract at line 1520
Request_Abstract|bool setControllerName(string $controller)

No description

Parameters

string $controller

Return Value

Request_Abstract|bool

in Request_Abstract at line 1529
Request_Abstract|bool setActionName(string $action)

No description

Parameters

string $action

Return Value

Request_Abstract|bool

in Request_Abstract at line 1536
string getMethod()

No description

Return Value

string

in Request_Abstract at line 1543
string getLanguage()

No description

Return Value

string

in Request_Abstract at line 1557
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

in Request_Abstract at line 1564
string getBaseUri()

No description

Return Value

string

in Request_Abstract at line 1571
string getRequestUri()

No description

Return Value

string

in Request_Abstract at line 1579
setRequestUri(string $uri)

Since: 2.1.0

No description

Parameters

string $uri

request URI

in Request_Abstract at line 1588
bool setDispatched()

Set request as dispatched

Return Value

bool

in Request_Abstract at line 1597
Request_Abstract|bool setRouted()

Set request as routed

Return Value

Request_Abstract|bool

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

Retrieve $_GET 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 2143
mixed getRequest(string $name = null, string $default = null)

Retrieve $_REQUEST 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 2155
mixed getPost(string $name = null, string $default = null)

Retrieve $_POST 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 2167
mixed getCookie(string $name = null, string $default = null)

Retrieve $_Cookie 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 2175
array getFiles(mixed $name = null, null $default = null)

No description

Parameters

mixed $name
null $default

Return Value

array

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

Retrieve variable from client, this method will search the name in $_REQUEST params, if the name is not found, then will search in $_POST, $_GET, $_COOKIE, $_SERVER

Parameters

string $name

the variable name
string $default

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

Return Value

mixed

at line 2213
__construct(string $method, string $controller, string $action, string $params = null)

No description

Parameters

string $method
string $controller
string $action
string $params

Exceptions

TypeError