Azalea\Request

Request 请求类

⚠️ Request 构造函数已私有,无法通过 new 方式实例化,仅通过 控制器getRequest 方法获得

// in controller-action
$request = $this->getRequest();
if ($request->isPost()) {
  // todo if post
}

Request::getUri


获取当前请求 Uri (即纯路径部分,不包含 query)

string Request::getUri ( void )
  • 参数

  • 返回值
    Uri 字符串

  • 范例

$uri = $request->getUri();  // 如 foo/bar

Request::getRequestUri


获取当前请求 RequestUri (包含路径部分和 query 部分)

string Request::getRequestUri ( void )
  • 参数

  • 返回值
    RequestUri 字符串

  • 范例

$requestUri = $request->getRequestUri();  // 如 foo/bar?hello=world

Request::getBaseUri


获取当前请求路径前缀,即相对于 DocumentRoot 的路径,通常为 /

string Request::getBaseUri ( void )
  • 参数

  • 返回值
    BaseUri 字符串

  • 范例

$baseUri = $request->BaseUri();  // 如 /path/to/index/

Request::isPost


判断是否为 POST 请求

bool Request::isPost ( void )
  • 参数

  • 返回值
    POST 请求返回 true,否则返回 false

  • 范例

if ($request->isPost()) {
    // todo if post
}

Request::isAjax


判断是否为 Ajax 请求 (XMLHttpRequest)

bool Request::isAjax ( void )
  • 参数

  • 返回值
    Ajax 请求返回 true,否则返回 false

  • 范例

if ($request->isAjax()) {
    // todo if ajax
}

Request::getQuery


获取 query 即 $_GET 参数值

string Request::getQuery ( string $key [, mixed $default = null] )

不建议直接使用 $_GET 超全局变量

  • 参数
    $key - query 键名
    $default - 如果键名不存在,则返回该默认值,默认为 null

  • 返回值
    query 值

  • 范例

// 请求为 /foo/bar?hello=world
$hello = $request->getQuery('hello', false);  // 返回 "world"

Request::getQueryTrim


获取 query 参数值,并清除前后空格

Request::getQuery,只是获取结果为字符串类型时,执行 trim() 方法清除前后空格

Request::getPost


获取 $_POST 参数值

string Request::getPost ( string $key [, mixed $default = null] )

不建议直接使用 $_POST 超全局变量

  • 参数
    $key - post 键名
    $default - 如果键名不存在,则返回该默认值,默认为 null

  • 返回值
    post 值

  • 范例

if ($request->isPost()) {
    $foo = $request->getPost('foo', false);  // 若 $_POST['foo'] 存在则返回值,否则返回 false
}

Request::getPostTrim


获取 $_POST 参数值,并清除前后空格

Request::getPost,只是获取结果为字符串类型时,执行 trim() 方法清除前后空格

Request::getCookie


获取 $_COOKIE 参数值

string Request::getCookie ( string $key [, mixed $default = null] )

不建议直接使用 $_COOKIE 超全局变量

  • 参数
    $key - cookie 键名
    $default - 如果键名不存在,则返回该默认值,默认为 null

  • 返回值
    cookie 值

  • 范例

$foo = $request->getCookie('foo', false);  // 若 $_COOKIE['foo'] 存在则返回值,否则返回 false

你可能感兴趣的:(Azalea\Request)