\think\model\concernAttribute

Summary

Methods

Properties

Constants

getPk()
getKey()
allowField()
readonly()
data()
appendData()
getOrigin()
getData()
getChangedData()
setAttr()
isAutoWriteTimestamp()
getAttr()
withAttribute()

No public properties found

No constants found

isPk()
autoWriteTimestamp()
writeTransform()
getRelationAttribute()
readTransform()

$pk
$field
$json
$jsonAssoc
$jsonType
$disuse
$readonly
$type

N/A

No private methods found

$data
$set
$origin
$withAttr

N/A

File: thinkphp/library/think/model/concern/Attribute.php
Package: Application
Class hierarchy: \think\model\concern\Attribute
Uses

Properties

$pk

$pk : string|array

数据表主键复合主键使用数组定义

Type

string|array —

$field

$field : array

数据表字段信息留空则自动获取

Type

array —

$json

$json : array

JSON数据表字段

Type

array —

$jsonAssoc

$jsonAssoc : bool

JSON数据取出是否需要转换为数组

Type

bool —

$jsonType

$jsonType : array

JSON数据表字段类型

Type

array —

$disuse

$disuse : array

数据表废弃字段

Type

array —

$readonly

$readonly : array

数据表只读字段

Type

array —

$type

$type : array

数据表字段类型

Type

array —

$data

$data : array

当前模型数据

Type

array —

$set

$set : array

修改器执行记录

Type

array —

$origin

$origin : array

原始数据

Type

array —

$withAttr

$withAttr : array

动态获取器

Type

array —

Methods

getPk()

getPk() : string|array

获取模型对象的主键

Returns

string|array —

getKey()

getKey() : int

获取模型对象的主键值

Returns

int —

allowField()

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

设置允许写入的字段

Parameters

array|string|true

$field

允许写入的字段如果为true只允许写入数据表字段

Returns

$this —

readonly()

readonly(array|string  $field) : $this

设置只读字段

Parameters

array|string

$field

只读字段

Returns

$this —

data()

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

设置数据对象值

Parameters

mixed	$data	数据或者属性名
mixed	$value	值

Returns

$this —

appendData()

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

批量设置数据对象值

Parameters

mixed	$data	数据
bool	$set	是否需要进行数据处理

Returns

$this —

getOrigin()

getOrigin(string  $name = null) : mixed

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

Parameters

string

$name

字段名留空获取全部

Returns

mixed —

getData()

getData(string  $name = null) : mixed

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

Parameters

string

$name

字段名留空获取全部

Throws

\InvalidArgumentException

Returns

mixed —

getChangedData()

getChangedData() : array

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

Returns

array —

setAttr()

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

修改器设置数据对象值

Parameters

string	$name	属性名
mixed	$value	属性值
array	$data	数据

isAutoWriteTimestamp()

isAutoWriteTimestamp(bool  $auto) : $this

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

Parameters

bool

$auto

Returns

$this —

getAttr()

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

获取器获取数据对象的值

Parameters

string	$name	名称
array	$item	数据

Throws

\InvalidArgumentException

Returns

mixed —

withAttribute()

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

设置数据字段获取器

Parameters

string\|array	$name	字段名
callable	$callback	闭包获取器

Returns

$this —

isPk()

isPk(string  $key) : bool

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

Parameters

string

$key

名称

Returns

bool —

autoWriteTimestamp()

autoWriteTimestamp(string  $name) : mixed

自动写入时间戳

Parameters

string

$name

时间戳字段

Returns

mixed —

writeTransform()

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

数据写入类型转换

Parameters

mixed	$value	值
string\|array	$type	要转换的类型

Returns

mixed —

getRelationAttribute()

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

获取关联属性值

Parameters

string	$name	属性名
array	$item	数据

Returns

mixed —

readTransform()

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

数据读取类型转换

Parameters

mixed	$value	值
string\|array	$type	要转换的类型

Returns

mixed —