\think\model\concernAttribute

模型数据处理

Summary

Methods

Properties

Constants

getPk()
getKey()
allowField()
readOnly()
data()
appendData()
getOrigin()
getData()
getChangedData()
set()
setAttrs()
setAttr()
getAttr()
withAttribute()

No public properties found

No constants found

isPk()
getRealFieldName()
writeTransform()
getValue()
getJsonValue()
getRelationValue()
readTransform()

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

N/A

No private methods found

$data
$origin
$set
$withAttr

N/A

File: vendor/topthink/think-orm/src/model/concern/Attribute.php
Package: Application
Class hierarchy: \think\model\concern\Attribute
Uses

Properties

$pk

$pk : string|array

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

Type

string|array —

$schema

$schema : array

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

Type

array —

$field

$field : array

当前允许写入的字段

Type

array —

$type

$type : array

字段自动类型转换

Type

array —

$disuse

$disuse : array

数据表废弃字段

Type

array —

$readonly

$readonly : array

数据表只读字段

Type

array —

$json

$json : array

JSON数据表字段

Type

array —

$jsonType

$jsonType : array

JSON数据表字段类型

Type

array —

$jsonAssoc

$jsonAssoc : bool

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

Type

bool —

$strict

$strict : bool

是否严格字段大小写

Type

bool —

$data

$data : array

当前模型数据

Type

array —

$origin

$origin : array

原始数据

Type

array —

$set

$set : array

修改器执行记录

Type

array —

$withAttr

$withAttr : array

动态获取器

Type

array —

Methods

getPk()

getPk() : string|array

获取模型对象的主键

Returns

string|array —

getKey()

getKey() : mixed

获取模型对象的主键值

Returns

mixed —

allowField()

allowField(array  $field) : $this

设置允许写入的字段

Parameters

array

$field

允许写入的字段

Returns

$this —

readOnly()

readOnly(array  $field) : $this

设置只读字段

Parameters

array

$field

只读字段

Returns

$this —

data()

data(array  $data, bool  $set = false, array  $allow = []) : $this

设置数据对象值

Parameters

array	$data	数据
bool	$set	是否调用修改器
array	$allow	允许的字段名

Returns

$this —

appendData()

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

批量追加数据对象值

Parameters

array	$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 —

set()

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

直接设置数据对象值

Parameters

string	$name	属性名
mixed	$value	值

setAttrs()

setAttrs(array  $data) : void

通过修改器批量设置数据对象值

Parameters

array

$data

数据

setAttr()

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

通过修改器设置数据对象值

Parameters

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

getAttr()

getAttr(string  $name) : mixed

获取器获取数据对象的值

Parameters

string

$name

名称

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 —

getRealFieldName()

getRealFieldName(string  $name) : string

获取实际的字段名

Parameters

string

$name

字段名

Returns

string —

writeTransform()

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

数据写入类型转换

Parameters

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

Returns

mixed —

getValue()

getValue(string  $name, mixed  $value, bool|string  $relation = false) : mixed

获取经过获取器处理后的数据对象的值

Parameters

string	$name	字段名称
mixed	$value	字段值
bool\|string	$relation	是否为关联属性或者关联名

Throws

\InvalidArgumentException

Returns

mixed —

getJsonValue()

getJsonValue(string  $name, mixed  $value) : mixed

获取JSON字段属性值

Parameters

string	$name	属性名
mixed	$value	JSON数据

Returns

mixed —

getRelationValue()

getRelationValue(string  $relation) : mixed

获取关联属性值

Parameters

string

$relation

关联名

Returns

mixed —

readTransform()

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

数据读取类型转换

Parameters

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

Returns

mixed —