\thinkModel

getPk()

getPk() : string|array

获取模型对象的主键

Returns

getKey()

getKey() : int

获取模型对象的主键值

Returns

allowField()

allowField(array|string|true  $field) : $this

设置允许写入的字段

Parameters

Returns

readonly()

readonly(array|string  $field) : $this

设置只读字段

Parameters

Returns

data()

data(mixed  $data, mixed  $value = null) : $this

设置数据对象值

Parameters

Returns

appendData()

appendData(mixed  $data, bool  $set = false) : $this

批量设置数据对象值

Parameters

Returns

getOrigin()

getOrigin(string  $name = null) : mixed

获取对象原始数据 如果不存在指定字段返回null

Parameters

Returns

getData()

getData(string  $name = null) : mixed

获取对象原始数据 如果不存在指定字段返回false

Parameters

Throws

\InvalidArgumentException

Returns

getChangedData()

getChangedData() : array

获取变化的数据 并排除只读数据

Returns

setAttr()

setAttr(string  $name, mixed  $value, array  $data = []) : void

修改器 设置数据对象值

Parameters

isAutoWriteTimestamp()

isAutoWriteTimestamp(bool  $auto) : $this

是否需要自动写入时间字段

Parameters

Returns

getAttr()

getAttr(string  $name, array  $item = null) : mixed

获取器 获取数据对象的值

Parameters

Throws

\InvalidArgumentException

Returns

withAttribute()

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

设置数据字段获取器

Parameters

Returns

setParent()

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

设置父关联对象

Parameters

Returns

getParent()

getParent() : \think\Model

获取父关联对象

Returns

getRelation()

getRelation(string  $name = null) : mixed

获取当前模型的关联模型数据

Parameters

Returns

setRelation()

setRelation(string  $name, mixed  $value, array  $data = []) : $this

设置关联数据对象值

Parameters

Returns

bindAttr()

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

绑定（一对一）关联属性到当前模型

Parameters

Throws

\think\Exception

Returns

together()

together(array|string  $relation) : $this

关联数据写入

Parameters

Returns

has()

has(string  $relation, mixed  $operator = '>=', int  $count = 1, string  $id = '*', string  $joinType = 'INNER') : \think\db\Query

根据关联条件查询当前模型

Parameters

Returns

hasWhere()

hasWhere(string  $relation, mixed  $where = [], mixed  $fields = '*') : \think\db\Query

根据关联条件查询当前模型

Parameters

Returns

relationQuery()

relationQuery(string|array  $relations, array  $withRelationAttr = []) : $this

查询当前模型的关联数据

Parameters

Returns

eagerlyResultSet()

eagerlyResultSet(array  $resultSet, string  $relation, array  $withRelationAttr = [], bool  $join = false) : array

预载入关联查询 返回数据集

Parameters

Returns

eagerlyResult()

eagerlyResult(\think\Model  $result, string  $relation, array  $withRelationAttr = [], bool  $join = false) : \think\Model

预载入关联查询 返回模型对象

Parameters

Returns

relationCount()

relationCount(\think\Model  $result, array  $relations, string  $aggregate = 'sum', string  $field = '*') : void

关联统计

Parameters

hasOne()

hasOne(string  $model, string  $foreignKey = '', string  $localKey = '') : \think\model\relation\HasOne

HAS ONE 关联定义

Parameters

Returns

belongsTo()

belongsTo(string  $model, string  $foreignKey = '', string  $localKey = '') : \think\model\relation\BelongsTo

BELONGS TO 关联定义

Parameters

Returns

hasMany()

hasMany(string  $model, string  $foreignKey = '', string  $localKey = '') : \think\model\relation\HasMany

HAS MANY 关联定义

Parameters

Returns

hasManyThrough()

hasManyThrough(string  $model, string  $through, string  $foreignKey = '', string  $throughKey = '', string  $localKey = '') : \think\model\relation\HasManyThrough

HAS MANY 远程关联定义

Parameters

Returns

belongsToMany()

belongsToMany(string  $model, string  $table = '', string  $foreignKey = '', string  $localKey = '') : \think\model\relation\BelongsToMany

BELONGS TO MANY 关联定义

Parameters

Returns

morphOne()

morphOne(string  $model, string|array  $morph = null, string  $type = '') : \think\model\relation\MorphOne

MORPH One 关联定义

Parameters

Returns

morphMany()

morphMany(string  $model, string|array  $morph = null, string  $type = '') : \think\model\relation\MorphMany

MORPH MANY 关联定义

Parameters

Returns

morphTo()

morphTo(string|array  $morph = null, array  $alias = []) : \think\model\relation\MorphTo

MORPH TO 关联定义

Parameters

Returns

event()

event(string  $event, callable  $callback, bool  $override = false) : void

注册回调方法

Parameters

flushEvent()

flushEvent() : void

清除回调方法

observe()

observe(object|string  $class) : void

注册一个模型观察者

Parameters

withEvent()

withEvent(bool  $event) : $this

当前操作的事件响应

Parameters

Returns

append()

append(array  $append = [], bool  $override = false) : $this

设置需要附加的输出属性

Parameters

Returns

appendRelationAttr()

appendRelationAttr(string  $attr, string|array  $append) : $this

设置附加关联对象的属性

Parameters

Throws

\think\Exception

Returns

hidden()

hidden(array  $hidden = [], bool  $override = false) : $this

设置需要隐藏的输出属性

Parameters

Returns

visible()

visible(array  $visible = [], bool  $override = false) : $this

设置需要输出的属性

Parameters

Returns

toArray()

toArray() : array

转换当前模型对象为数组

Returns

toJson()

toJson(int  $options = JSON_UNESCAPED_UNICODE) : string

转换当前模型对象为JSON字符串

Parameters

Returns

removeRelation()

removeRelation() : $this

移除当前模型的关联属性

Returns

__toString()

__toString() : mixed

Returns

jsonSerialize()

jsonSerialize() : mixed

Returns

toCollection()

toCollection(array|\think\Collection  $collection, string  $resultSetType = null) : \think\Collection

转换数据集为数据集对象

Parameters

Returns

__construct()

__construct(array|object  $data = []) : mixed

架构函数

Parameters

Returns

getName()

getName() : string

获取当前模型名称

Returns

readMaster()

readMaster(bool  $all = false) : $this

是否从主库读取数据（主从分布有效）

Parameters

Returns

newInstance()

newInstance(array|object  $data = [], bool  $isUpdate = false, mixed  $where = null) : \think\Model

创建新的模型实例

Parameters

Returns

setQuery()

setQuery(\think\db\Query  $query) : $this

获取当前模型的数据库查询对象

Parameters

Returns

db()

db(bool|array  $useBaseQuery = true) : \think\db\Query

获取当前模型的数据库查询对象

Parameters

Returns

force()

force(bool  $force = true) : $this

更新是否强制写入数据 而不做比较

Parameters

Returns

isForce()

isForce() : bool

判断force

Returns

replace()

replace(bool  $replace = true) : $this

新增数据是否使用Replace

Parameters

Returns

exists()

exists(bool  $exists) : $this

设置数据是否存在

Parameters

Returns

isExists()

isExists() : bool

判断数据是否存在数据库

Returns

isEmpty()

isEmpty() : bool

判断模型是否为空

Returns

save()

save(array  $data = [], array  $where = [], string  $sequence = null) : bool

保存当前数据对象

Parameters

Returns

setInc()

setInc(string  $field, int  $step = 1, int  $lazyTime) : bool

字段值(延迟)增长

Parameters

Throws

\think\Exception

Returns

setDec()

setDec(string  $field, int  $step = 1, int  $lazyTime) : bool

字段值(延迟)减少

Parameters

Throws

\think\Exception

Returns

saveAll()

saveAll(array  $dataSet, bool  $replace = true) : \think\Collection

保存多个数据到当前数据对象

Parameters

Throws

\Exception

Returns

isUpdate()

isUpdate(mixed  $update = true, mixed  $where = null) : $this

是否为更新数据

Parameters

Returns

delete()

delete() : bool

删除当前的记录

Returns

auto()

auto(array  $fields) : $this

设置自动完成的字段（ 规则通过修改器定义）

Parameters

Returns

create()

create(array  $data = [], array|true  $field = null, bool  $replace = false) : static

写入数据

Parameters

Returns

update()

update(array  $data = [], array  $where = [], array|true  $field = null) : static

更新数据

Parameters

Returns

destroy()

destroy(mixed  $data) : bool

删除记录

Parameters

Returns

getError()

getError() : mixed

获取错误信息

Returns

__wakeup()

__wakeup() : mixed

解序列化后处理

Returns

__debugInfo()

__debugInfo() : mixed

Returns

__set()

__set(string  $name, mixed  $value) : void

修改器 设置数据对象的值

Parameters

__get()

__get(string  $name) : mixed

获取器 获取数据对象的值

Parameters

Returns

__isset()

__isset(string  $name) : bool

检测数据对象的值

Parameters

Returns

__unset()

__unset(string  $name) : void

销毁数据对象的值

Parameters

offsetSet()

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

Parameters

Returns

offsetExists()

offsetExists(mixed  $name) : mixed

Parameters

Returns

offsetUnset()

offsetUnset(mixed  $name) : mixed

Parameters

Returns

offsetGet()

offsetGet(mixed  $name) : mixed

Parameters

Returns

useGlobalScope()

useGlobalScope(bool|array  $use) : \think\db\Query

设置是否使用全局查询范围

Parameters

Returns

__call()

__call(mixed  $method, mixed  $args) : mixed

Parameters

Returns

__callStatic()

__callStatic(mixed  $method, mixed  $args) : mixed

Parameters

Returns

scope()

scope(string|array  $scope) : $this

static 查询范围

Parameters

Returns

where()

where(mixed  $field, string  $op = null, mixed  $condition = null) : $this

static 查询条件

Parameters

Returns

whereRaw()

whereRaw(string  $where, array  $bind = [], string  $logic = 'AND') : $this

static 表达式查询

Parameters

Returns

whereExp()

whereExp(string  $field, string  $condition, array  $bind = [], string  $logic = 'AND') : $this

static 字段表达式查询

Parameters

Returns

when()

when(mixed  $condition, mixed  $query, mixed  $otherwise = null) : $this

static 条件查询

Parameters

Returns

join()

join(mixed  $join, mixed  $condition = null, string  $type = 'INNER', array  $bind = []) : $this

static JOIN查询

Parameters

Returns

view()

view(mixed  $join, mixed  $field = null, mixed  $on = null, string  $type = 'INNER') : $this

static 视图查询

Parameters

Returns

with()

with(mixed  $with, callable  $callback = null) : $this

static 关联预载入

Parameters

Returns

count()

count(string  $field = '*') : $this

static Count统计查询

Parameters

Returns

min()

min(string  $field, bool  $force = true) : $this

static Min统计查询

Parameters

Returns

max()

max(string  $field, bool  $force = true) : $this

static Max统计查询

Parameters

Returns

sum()

sum(string  $field) : $this

static SUM统计查询

Parameters

Returns

avg()

avg(string  $field) : $this

static Avg统计查询

Parameters

Returns

field()

field(mixed  $field, bool  $except = false, string  $tableName = '', string  $prefix = '', string  $alias = '') : $this

static 指定查询字段

Parameters

Returns

fieldRaw()

fieldRaw(string  $field) : $this

static 指定查询字段

Parameters

Returns

union()

union(mixed  $union, bool  $all = false) : $this

static UNION查询

Parameters

Returns

limit()

limit(mixed  $offset, int  $length = null) : $this

static 查询LIMIT

Parameters

Returns

order()

order(mixed  $field, string  $order = null) : $this

static 查询ORDER

Parameters

Returns

orderRaw()

orderRaw(string  $field, array  $bind = []) : $this

static 查询ORDER

Parameters

Returns

cache()

cache(mixed  $key = null, int|\DateTime  $expire = null, string  $tag = null) : $this

static 设置查询缓存

Parameters

Returns

value()

value(string  $field, mixed  $default = null) : mixed

static 获取某个字段的值

Parameters

Returns

column()

column(string  $field, string  $key = '') : array

static 获取某个列的值

Parameters

Returns

find()

find(mixed  $data = null) : $this

static 查询单个记录

Parameters

Returns

findOrFail()

findOrFail(mixed  $data = null) : $this

查询单个记录

Parameters

Returns

Collection()

Collection() : void

|$this[] select(mixed $data = null) static 查询多个记录

get()

get(mixed  $data = null, mixed  $with = [], bool  $cache = false, bool  $failException = false) : $this

static 查询单个记录 支持关联预载入

Parameters

Returns

getOrFail()

getOrFail(mixed  $data = null, mixed  $with = [], bool  $cache = false) : $this

static 查询单个记录 不存在则抛出异常

Parameters

Returns

findOrEmpty()

findOrEmpty(mixed  $data = null) : $this

static 查询单个记录 不存在则返回空模型

Parameters

Returns

Collection()

Collection() : void

|$this[] all(mixed $data = null, mixed $with = [], bool $cache = false) static 查询多个记录 支持关联预载入

withAttr()

withAttr(array  $name, \Closure  $closure = null) : $this

static 动态定义获取器

Parameters

Returns

withJoin()

withJoin(string|array  $with, string  $joinType = '') : $this

static

Parameters

Returns

withCount()

withCount(string|array  $relation, bool  $subQuery = true) : $this

static 关联统计

Parameters

Returns

withSum()

withSum(string|array  $relation, string  $field, bool  $subQuery = true) : $this

static 关联SUM统计

Parameters

Returns

withMax()

withMax(string|array  $relation, string  $field, bool  $subQuery = true) : $this

static 关联MAX统计

Parameters

Returns

withMin()

withMin(string|array  $relation, string  $field, bool  $subQuery = true) : $this

static 关联Min统计

Parameters

Returns

withAvg()

withAvg(string|array  $relation, string  $field, bool  $subQuery = true) : $this

static 关联Avg统计

Parameters

Returns

paginate()

paginate(int|array  $listRows = null, int|bool  $simple = false, array  $config = []) : \think\Paginator|$this

static 分页

Parameters

Returns

isPk()

isPk(string  $key) : bool

判断一个字段名是否为主键字段

Parameters

Returns

autoWriteTimestamp()

autoWriteTimestamp(string  $name) : mixed

自动写入时间戳

Parameters

Returns

writeTransform()

writeTransform(mixed  $value, string|array  $type) : mixed

数据写入 类型转换

Parameters

Returns

getRelationAttribute()

getRelationAttribute(string  $name, array  $item) : mixed

获取关联属性值

Parameters

Returns

readTransform()

readTransform(mixed  $value, string|array  $type) : mixed

数据读取 类型转换

Parameters

Returns

parseModel()

parseModel(string  $model) : string

解析模型的完整命名空间

Parameters

Returns

getForeignKey()

getForeignKey(string  $name) : string

获取模型的默认外键名

Parameters

Returns

isRelationAttr()

isRelationAttr(string  $attr) : string|false

检查属性是否为关联属性 如果是则返回关联方法名

Parameters

Returns

getRelationData()

getRelationData(\think\model\Relation  $modelRelation) : mixed

智能获取关联模型数据

Parameters

Returns

checkAutoRelationWrite()

checkAutoRelationWrite() : void

关联数据自动写入检查

autoRelationUpdate()

autoRelationUpdate() : void

自动关联数据更新（针对一对一关联）

autoRelationInsert()

autoRelationInsert() : void

自动关联数据写入（针对一对一关联）

autoRelationDelete()

autoRelationDelete() : void

自动关联数据删除（支持一对一及一对多关联）

trigger()

trigger(string  $event) : bool

触发事件

Parameters

Returns

beforeInsert()

beforeInsert(callable  $callback, bool  $override = false) : mixed

模型before_insert事件快捷方法

Parameters

Returns

afterInsert()

afterInsert(callable  $callback, bool  $override = false) : mixed

模型after_insert事件快捷方法

Parameters

Returns

beforeUpdate()

beforeUpdate(callable  $callback, bool  $override = false) : mixed

模型before_update事件快捷方法

Parameters

Returns

afterUpdate()

afterUpdate(callable  $callback, bool  $override = false) : mixed

模型after_update事件快捷方法

Parameters