Skip to content

RequestModelParams — 请求模型查询参数

  • 文件位置: kernel/Foundation/HTTP/Request/RequestModelParams.php
  • 命名空间: kernel\Foundation\HTTP\Request
  • 继承: 继承 kernel\Foundation\HTTP\Request\RequestData
  • 是否可继承: 是

封装请求中用于模型查询的分页与排序参数,供数据层直接构造查询。构造时从 query 读取并转换。

分页参数(任一存在则 paged(true)):

  • page(默认 1)/ limitperPage(默认 10)/ skip

排序参数(任一存在则 ordered(true)):

  • order:排序字段
  • orderBy:排序方式(DESC / ASC
  • orders:多条排序,逗号分隔,每项 字段[:排序方式](如 id:DESC,name:ASC

属性

属性类型默认可见性说明
$_orderarray[]private单条排序 ["fieldName"=>, "sort"=>]
$_ordersarray[]private多条排序规则
$_orderedboolfalseprotected是否传了排序参数
$_pageint1protected页码
$_perPageint10protected每页条数
$_skipint|nullnullprotected跳过的记录数
$_pagedboolfalseprotected是否传了分页参数

方法速查表

方法作用
__construct(Request $R)构造:解析分页与排序参数
order($fieldName)获取/设置排序字段
orderBy($sort)获取/设置排序方式
orders($rules)获取/设置多条排序规则
ordered($flag)获取/设置是否传了排序参数
page($page)获取/设置页码
perPage($count)获取/设置每页条数
skip($count)获取/设置跳过条数
paged($flag)获取/设置是否传了分页参数

方法

__construct(Request $R) — 构造

解析分页与排序参数,设置对应标记。

参数

参数类型默认说明
$RRequest请求实例

返回值

  • 无。

order($fieldName = null) — 获取/设置排序字段

参数

参数类型默认说明
$fieldNamestring|nullnull传入则设置排序字段

返回值

  • string\|null:排序字段名;未设置返回 null

orderBy($sort = null) — 获取/设置排序方式

参数

参数类型默认说明
$sortstring|nullnull传入则设置排序方式(DESC / ASC

返回值

  • string\|null:排序方式;未设置返回 null

orders($rules = null) — 获取/设置多条排序规则

参数

参数类型默认说明
$rulesarray|nullnull传入则设置多条规则(键=字段名,值=DESC/ASC

返回值

  • array\|null:排序规则;未设置返回 null

ordered($flag = null) — 获取/设置是否传了排序参数

参数

参数类型默认说明
$flagbool|nullnull传入则设置标记

返回值

  • bool:是否传了排序参数。

page($page = null) — 获取/设置页码

参数

参数类型默认说明
$pageint|nullnull传入则设置页码

返回值

  • int:页码。

perPage($count = null) — 获取/设置每页条数

参数

参数类型默认说明
$countint|nullnull传入则设置每页条数

返回值

  • int:每页条数。

skip($count = null) — 获取/设置跳过条数

参数

参数类型默认说明
$countint|nullnull传入则设置跳过条数

返回值

  • int\|null:跳过条数。

paged($flag = null) — 获取/设置是否传了分页参数

参数

参数类型默认说明
$flagbool|nullnull传入则设置标记

返回值

  • bool:是否传了分页参数。

继承自 RequestDatahas() / get() / some() / handle() 等可用,见《RequestData》页。