Properties

$items

$items : array

数据集数据

Type

array

Methods

__construct()

__construct(mixed  $items = []) : mixed

Parameters

mixed $items

Returns

mixed —

make()

make(mixed  $items = []) : mixed

Parameters

mixed $items

Returns

mixed —

isEmpty()

isEmpty() : bool

是否为空

Returns

bool —

toArray()

toArray() : array

Returns

array —

all()

all() : array

Returns

array —

merge()

merge(mixed  $items) : static

合并数组

Parameters

mixed $items

数据

Returns

static —

dictionary()

dictionary(mixed  $items = null, string  $indexKey = null) : array

按指定键整理数据

Parameters

mixed $items

数据

string $indexKey

键名

Returns

array —

diff()

diff(mixed  $items, string  $indexKey = null) : static

比较数据集,返回差集

Parameters

mixed $items

数据

string $indexKey

指定比较的键名

Returns

static —

intersect()

intersect(mixed  $items, string  $indexKey = null) : static

比较数据集,返回交集

Parameters

mixed $items

数据

string $indexKey

指定比较的键名

Returns

static —

flip()

flip() : static

交换数组中的键和值

Returns

static —

keys()

keys() : static

返回数组中所有的键名

Returns

static —

values()

values() : static

返回数组中所有的值组成的新 Collection 实例

Returns

static —

pop()

pop() : mixed

删除数组的最后一个元素(出栈)

Returns

mixed —

reduce()

reduce(callable  $callback, mixed  $initial = null) : mixed

通过使用用户自定义函数,以字符串返回数组

Parameters

callable $callback

调用方法

mixed $initial

Returns

mixed —

reverse()

reverse() : static

以相反的顺序返回数组。

Returns

static —

shift()

shift() : mixed

删除数组中首个元素,并返回被删除元素的值

Returns

mixed —

push()

push(mixed  $value, string  $key = null) : void

在数组结尾插入一个元素

Parameters

mixed $value

元素

string $key

KEY

chunk()

chunk(int  $size, bool  $preserveKeys = false) : static

把一个数组分割为新的数组块.

Parameters

int $size

块大小

bool $preserveKeys

Returns

static —

unshift()

unshift(mixed  $value, string  $key = null) : void

在数组开头插入一个元素

Parameters

mixed $value

元素

string $key

KEY

each()

each(callable  $callback) : $this

给每个元素执行个回调

Parameters

callable $callback

回调

Returns

$this —

map()

map(callable|null  $callback) : static

用回调函数处理数组中的元素

Parameters

callable|null $callback

回调

Returns

static —

filter()

filter(callable|null  $callback = null) : static

用回调函数过滤数组中的元素

Parameters

callable|null $callback

回调

Returns

static —

where()

where(string  $field, mixed  $operator, mixed  $value = null) : static

根据字段条件过滤数组中的元素

Parameters

string $field

字段名

mixed $operator

操作符

mixed $value

数据

Returns

static —

whereLike()

whereLike(string  $field, string  $value) : static

LIKE过滤

Parameters

string $field

字段名

string $value

数据

Returns

static —

whereNotLike()

whereNotLike(string  $field, string  $value) : static

NOT LIKE过滤

Parameters

string $field

字段名

string $value

数据

Returns

static —

whereIn()

whereIn(string  $field, array  $value) : static

IN过滤

Parameters

string $field

字段名

array $value

数据

Returns

static —

whereNotIn()

whereNotIn(string  $field, array  $value) : static

NOT IN过滤

Parameters

string $field

字段名

array $value

数据

Returns

static —

whereBetween()

whereBetween(string  $field, mixed  $value) : static

BETWEEN 过滤

Parameters

string $field

字段名

mixed $value

数据

Returns

static —

whereNotBetween()

whereNotBetween(string  $field, mixed  $value) : static

NOT BETWEEN 过滤

Parameters

string $field

字段名

mixed $value

数据

Returns

static —

column()

column(string|null  $columnKey, string|null  $indexKey = null) : array

返回数据中指定的一列

Parameters

string|null $columnKey

键名

string|null $indexKey

作为索引值的列

Returns

array —

sort()

sort(callable|null  $callback = null) : static

对数组排序

Parameters

callable|null $callback

回调

Returns

static —

order()

order(string  $field, string  $order = 'asc') : $this

指定字段排序

Parameters

string $field

排序字段

string $order

排序

Returns

$this —

shuffle()

shuffle() : static

将数组打乱

Returns

static —

first()

first(callable|null  $callback = null, null  $default = null) : mixed

获取最第一个单元数据

Parameters

callable|null $callback
null $default

Returns

mixed —

last()

last(callable|null  $callback = null, null  $default = null) : mixed

获取最后一个单元数据

Parameters

callable|null $callback
null $default

Returns

mixed —

slice()

slice(int  $offset, int  $length = null, bool  $preserveKeys = false) : static

截取数组

Parameters

int $offset

起始位置

int $length

截取长度

bool $preserveKeys

preserveKeys

Returns

static —

offsetExists()

offsetExists(mixed  $offset) : mixed

Parameters

mixed $offset

Returns

mixed —

offsetGet()

offsetGet(mixed  $offset) : mixed

Parameters

mixed $offset

Returns

mixed —

offsetSet()

offsetSet(mixed  $offset, mixed  $value) : mixed

Parameters

mixed $offset
mixed $value

Returns

mixed —

offsetUnset()

offsetUnset(mixed  $offset) : mixed

Parameters

mixed $offset

Returns

mixed —

count()

count() : mixed

Returns

mixed —

getIterator()

getIterator() : mixed

Returns

mixed —

jsonSerialize()

jsonSerialize() : mixed

Returns

mixed —

toJson()

toJson(int  $options = JSON_UNESCAPED_UNICODE) : string

转换当前数据集为JSON字符串

Parameters

int $options

json参数

Returns

string —

__toString()

__toString() : mixed

Returns

mixed —

load()

load(array|string  $relation, mixed  $cache = false) : $this

延迟预载入关联查询

Parameters

array|string $relation

关联

mixed $cache

关联缓存

Returns

$this —

delete()

delete() : bool

删除数据集的数据

Returns

bool —

update()

update(array  $data, array  $allowField = []) : bool

更新数据

Parameters

array $data

数据数组

array $allowField

允许字段

Returns

bool —

hidden()

hidden(array  $hidden) : $this

设置需要隐藏的输出属性

Parameters

array $hidden

属性列表

Returns

$this —

visible()

visible(array  $visible) : $this

设置需要输出的属性

Parameters

array $visible

Returns

$this —

append()

append(array  $append) : $this

设置需要追加的输出属性

Parameters

array $append

属性列表

Returns

$this —

setParent()

setParent(\think\Model  $parent) : $this

设置父模型

Parameters

\think\Model $parent

父模型

Returns

$this —

withAttr()

withAttr(string|array  $name, callable  $callback = null) : $this

设置数据字段获取器

Parameters

string|array $name

字段名

callable $callback

闭包获取器

Returns

$this —

bindAttr()

bindAttr(string  $relation, array  $attrs = []) : $this

绑定(一对一)关联属性到当前模型

Parameters

string $relation

关联名称

array $attrs

绑定属性

Throws

\think\model\Exception

Returns

$this —

convertToArray()

convertToArray(mixed  $items) : array

转换成数组

Parameters

mixed $items

数据

Returns

array —