Documentation

ASModel extends ASBase
in

基础模型组件 ASModel

模型抽象类、集成了数据库查询、数据转换、缓存、Redis访问等 Abstract class, integrated database query, data conversion, cache, Redis access, etc.

Table of Contents

$table 数据表名 string
$primaryid 主索引字段 string
$addFields 添加支持字段 array
$updateFields 更新支持字段 array
$detailFields 详情支持字段 array
$publicDetailFields 外部接口详情支持字段 array
$overviewFields 概览支持字段 array
$listFields 列表支持字段 array
$publicListFields 外部接口列表支持字段 array
$countFilters 计数查询支持筛选字段 array
$depthStruct 多重数据结构 array
$searchFilters 搜索支持字段 array
$record_enabled 开启日志 bool
$rds_auto_cache 自动使用REDIS缓存 bool
$Redis Redis缓存 ASRedis
$RedisHash 缓存hash mixed
$table 表名称 Table name string
$fields 目标字段 Target fields array
$id 主体id Event id string
$params 事件参数暂存 Parameters tmp array
$searchFilters 搜索过滤字段 array
$record_enabled 开启日志 bool
$DB 数据库链接 SQL Connect ASDB
$Record 监控器 Recorder ASRecord
$CLASSNAME 类名 string
$result 结果包装器 ASResult
__construct() ASBase constructor. mixed
common() 通用单例 common static
add() 添加数据 add data to Database ASResult
beforeAdd() 函数注入(插入数据之前) Do something before add mixed
beforeAddReturn() 函数注入(插入数据返回结果之前) Do something before add result returning mixed
adds() 批量添加 adds ASResult
beforeAdds() mixed
beforeAddsReturn() mixed
update() 更新单行数据 update data with itemid ASResult
beforeUpdate() mixed
beforeUpdateReturn() mixed
publicUpdate() mixed
remove() 移除 remove ASResult
beforeRemove() mixed
beforeRemoveReturn() mixed
publicRemove() 开放接口移除 publicRemove ASResult
detail() 查询唯一数据详情 Get detail by itemid ASResult
beforeDetail() mixed
beforeDetailReturn() mixed
publicDetail() 获取公开接口详情 Detail for with public fields ASResult
get() 通过ID获取对应字段值 get value at $key field by itemid ASResult
beforeGet() mixed
beforeGetReturn() mixed
overview() 获取概览 overview ASResult
count() 统计特定数量 count ASResult
has() 查询是否存在对应数据 Check data is exist by filters bool
beforeCount() mixed
beforeCountReturn() mixed
countContent() 查询对应item表所对应的行数 Count contents in item table ASResult
countContentInTable() 查询指定表中所对应的行数 Count contents in specific table ASResult
_isCacheEnabled() 是否支持缓存(Redis) Is cache(Redis) supported in environment bool
_hasCache() 是否存在对应缓存数据 _hasCache bool
_getCache() 取出缓存 Get cache from Redis server mixed
_cache() 缓存数据 Cache data to Redis server bool
_trackCache() 跟踪缓存 trackCache 将对应id的缓存加入到Set中,清空的时候可以将相关缓存一并清理,防止出现关联缓存不同步的问题 Add the cache of the corresponding id to the Set, For to ensure that related caches can be cleared together when emptying. bool
_clearSet() 清空Set下的缓存 clear Cache in set bool
list() 获取列表 Get list ASResult
beforeList() mixed
beforeListReturn() mixed
publicList() mixed
joinCount() 多表联合统计 joinCount ASResult
advancedJoinCount() 多表联合查询统计 完整模式 advancedJoinCount ASResult
beforeJoinCount() mixed
beforeJoinCountReturn() mixed
joinHas() 多表联合检测是否存在 joinHas bool
joinList() 多表联合查询 joinList ASResult
advancedJoinList() mixed
beforeJoinList() mixed
beforeJoinListReturn() mixed
joinDetail() 多表联合详情 joinDetail ASResult
beforeJoinDetail() mixed
beforeJoinDetailReturn() mixed
fillJoinParams() 自动完善JOIN参数 fillJoinParams array
search() mixed
convert() mixed
status() 设置状态 status ASResult
beforeStatus() mixed
block() mixed
trash() mixed
sketch() mixed
offline() mixed
online() mixed
recover() mixed
done() mixed
expire() mixed
pending() mixed
pedding() mixed
setFeature() mixed
cancelFeature() mixed
setSort() mixed
increaseSort() mixed
decreaseSort() mixed
view() mixed
increase() mixed
isStatus() mixed
isExist() mixed
__construct() ASObject constructor. mixed
setTable() mixed
setId() mixed
DBAdd() 添加数据到DB DBAdd mixed
DBAdds() 批量添加数据 DBAdds mixed
DBGet() 获取数据 DBGet mixed
DBUpdate() 更新数据 Update to database mixed
DBUpdates() 批量更新数据 DBUpdates mixed
DBRemove() 从数据库中删除行 DBRemove mixed
DBCount() 统计数据库中对应行数 Count valid rows with conditions mixed
DBCheck() 在数据库中检测字段是否是对应数据 Check data is valid at field mixed
DBNatureCount() 基于自然语言关键词查询计数 DBNatureCount mixed
DBNatureGet() 基于自然语言关键词查询 Get data with nature language keyword search mixed
DBJoinCount() 联合查询计数 DBJoinCount mixed
DBJoinGet() 联合查询 DBJoinGet mixed
record() 记录日志到数据 Make a record to DB mixed
take() 设置主体别称 Alias of setContent $this
setContent() 设置结果包装中的主数据 set content of result mixed
sign() 设置方法签名 Set method sign mixed
feedback() 返回结果 通用 Returning result to the caller ASResult
error() 返回错误 Returning Error result ASResult
success() 返回成功 Return Success result ASResult

Properties

$table

数据表名

protected static string $table

$primaryid

主索引字段

protected static string $primaryid

$addFields

添加支持字段

protected static array $addFields

$updateFields

更新支持字段

protected static array $updateFields

$detailFields

详情支持字段

protected static array $detailFields

$publicDetailFields

外部接口详情支持字段

protected static array $publicDetailFields

$overviewFields

概览支持字段

protected static array $overviewFields

$listFields

列表支持字段

protected static array $listFields

$publicListFields

外部接口列表支持字段

protected static array $publicListFields

$countFilters

计数查询支持筛选字段

protected static array $countFilters

$depthStruct

多重数据结构

protected static array $depthStruct = null

$searchFilters

搜索支持字段

protected static array $searchFilters = null

$record_enabled

开启日志

protected bool $record_enabled = true

$rds_auto_cache

自动使用REDIS缓存

protected bool $rds_auto_cache = false

$RedisHash

缓存hash

protected mixed $RedisHash

$table

表名称 Table name

protected static string $table

$fields

目标字段 Target fields

protected array $fields = '*'

$id

主体id Event id

protected string $id

$params

事件参数暂存 Parameters tmp

protected array $params

$searchFilters

搜索过滤字段

protected static array $searchFilters = ['title', 'description']

$record_enabled

开启日志

protected bool $record_enabled = true

$CLASSNAME

类名

protected string $CLASSNAME

Methods

__construct()

ASBase constructor.

public __construct( [ $enableRecord : bool = true ] ) : mixed
Parameters
$enableRecord : bool = true

是否开启日志记录

Return values
mixed

common()

通用单例 common

protected static common( ) : static
Return values
static

add()

添加数据 add data to Database

public add( $data : array ) : ASResult
Parameters
$data : array
Return values
ASResult

beforeAdd()

函数注入(插入数据之前) Do something before add

public beforeAdd( &$data : array ) : mixed
Parameters
$data : array
Return values
mixed

beforeAddReturn()

函数注入(插入数据返回结果之前) Do something before add result returning

public beforeAddReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult

插入数据(指针)

Return values
mixed

beforeAdds()

public beforeAdds( &$list : array ) : mixed
Parameters
$list : array
Return values
mixed

beforeAddsReturn()

public beforeAddsReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

update()

更新单行数据 update data with itemid

public update( $data : array , $itemid : string ) : ASResult
Parameters
$data : array
$itemid : string
Return values
ASResult

beforeUpdate()

public beforeUpdate( &$data : array ) : mixed
Parameters
$data : array
Return values
mixed

beforeUpdateReturn()

public beforeUpdateReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

publicUpdate()

public publicUpdate( $data : array , $itemid : string , $userid : string ) : mixed
Parameters
$data : array
$itemid : string
$userid : string
Return values
mixed

remove()

移除 remove

public remove( $itemid : string ) : ASResult
Parameters
$itemid : string
Return values
ASResult

beforeRemove()

public beforeRemove( &$itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

beforeRemoveReturn()

public beforeRemoveReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

publicRemove()

开放接口移除 publicRemove

public publicRemove( $itemid : string , $userid : string ) : ASResult
Parameters
$itemid : string
$userid : string
Return values
ASResult

detail()

查询唯一数据详情 Get detail by itemid

public detail( $itemid : string [, $public : bool = false ] ) : ASResult
Parameters
$itemid : string
$public : bool = false
Return values
ASResult

beforeDetail()

public beforeDetail( &$itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

beforeDetailReturn()

public beforeDetailReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

publicDetail()

获取公开接口详情 Detail for with public fields

public publicDetail( $itemid : string ) : ASResult
Parameters
$itemid : string
Return values
ASResult

get()

通过ID获取对应字段值 get value at $key field by itemid

public get( $key : string , $itemid : string ) : ASResult
Parameters
$key : string
$itemid : string
Return values
ASResult

beforeGet()

public beforeGet( &$key : string , &$itemid : string ) : mixed
Parameters
$key : string
$itemid : string
Return values
mixed

beforeGetReturn()

public beforeGetReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

overview()

获取概览 overview

public overview( $itemid : string ) : ASResult
Parameters
$itemid : string
Return values
ASResult

count()

统计特定数量 count

public count( $filters : array ) : ASResult
Parameters
$filters : array
Return values
ASResult

has()

查询是否存在对应数据 Check data is exist by filters

public has( $filters : array ) : bool
Parameters
$filters : array
Return values
bool

beforeCount()

public beforeCount( &$filters : array ) : mixed
Parameters
$filters : array
Return values
mixed

beforeCountReturn()

public beforeCountReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

countContent()

查询对应item表所对应的行数 Count contents in item table

public countContent( $filters : array , $type : string ) : ASResult
Parameters
$filters : array
$type : string
Return values
ASResult

countContentInTable()

查询指定表中所对应的行数 Count contents in specific table

public countContentInTable( $filters : array , $table : string ) : ASResult
Parameters
$filters : array
$table : string
Return values
ASResult

_isCacheEnabled()

是否支持缓存(Redis) Is cache(Redis) supported in environment

public _isCacheEnabled( ) : bool
Return values
bool

_hasCache()

是否存在对应缓存数据 _hasCache

public _hasCache( [ $hash : string|null = null ] ) : bool
Parameters
$hash : string|null = null

缓存哈希

Return values
bool

_getCache()

取出缓存 Get cache from Redis server

public _getCache( [ $hash : string|null = null ] ) : mixed
Parameters
$hash : string|null = null
Return values
mixed

_cache()

缓存数据 Cache data to Redis server

public _cache( [ $hash : mixed = null ] [, $result : mixed = null ] [, $expireDuration : int = 3600 ] ) : bool
Parameters
$hash : mixed = null
$result : mixed = null
$expireDuration : int = 3600
Return values
bool

_trackCache()

跟踪缓存 trackCache 将对应id的缓存加入到Set中,清空的时候可以将相关缓存一并清理,防止出现关联缓存不同步的问题 Add the cache of the corresponding id to the Set, For to ensure that related caches can be cleared together when emptying.

public _trackCache( $set : , $id : , $hashID : ) : bool
Parameters
$set :
$id :
$hashID :
Return values
bool

_clearSet()

清空Set下的缓存 clear Cache in set

public _clearSet( $set : , $id : ) : bool
Parameters
$set :
$id :
Return values
bool

list()

获取列表 Get list

public list( $filters : array [, $page : int = 1 ] [, $size : int = 25 ] [, $sort : string|null = null ] [, $public : bool = false ] ) : ASResult
Parameters
$filters : array

筛选条件

$page : int = 1

翻页-页数

$size : int = 25

翻页-页长

$sort : string|null = null

排序字段

$public : bool = false

是否公开列表

Return values
ASResult

结果对象

beforeList()

public beforeList( &$filters : array [, &$page : int = 1 ] [, &$size : int = 25 ] [, &$sort : string = null ] [, &$public : mixed = false ] ) : mixed
Parameters
$filters : array
$page : int = 1
$size : int = 25
$sort : string = null
$public : mixed = false
Return values
mixed

beforeListReturn()

public beforeListReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

publicList()

public publicList( $filters : array [, $page : int = 1 ] [, $size : int = 25 ] [, $sort : string = null ] ) : mixed
Parameters
$filters : array
$page : int = 1
$size : int = 25
$sort : string = null
Return values
mixed

joinCount()

多表联合统计 joinCount

public joinCount( [ $filters : array = null ] [, $mergeJoins : array = null ] [, $subJoins : array|null = null ] ) : ASResult
Parameters
$filters : array = null

[主表条件]

$mergeJoins : array = null

[合并查询表]

$subJoins : array|null = null

[合并查询表(子集)]

Return values
ASResult

advancedJoinCount()

多表联合查询统计 完整模式 advancedJoinCount

public advancedJoinCount( [ $primaryParams : array|null = null ] [, $mergeJoins : array|null = null ] [, $subJoins : array|null = null ] ) : ASResult
Parameters
$primaryParams : array|null = null
$mergeJoins : array|null = null
$subJoins : array|null = null
Return values
ASResult

beforeJoinCount()

public beforeJoinCount( [ &$filters : array = null ] [, &$mergeJoins : array = null ] [, &$subJoins : array = null ] ) : mixed
Parameters
$filters : array = null
$mergeJoins : array = null
$subJoins : array = null
Return values
mixed

beforeJoinCountReturn()

public beforeJoinCountReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

joinHas()

多表联合检测是否存在 joinHas

public joinHas( [ $filters : array|null = null ] [, $joins : array|null = null ] ) : bool
Parameters
$filters : array|null = null

主表条件

$joins : array|null = null

合并查询表

Return values
bool

joinList()

多表联合查询 joinList

public joinList( [ $filters : array = null ] [, $mergeJoins : array = null ] [, $subJoins : array|null = null ] [, $page : int = 1 ] [, $size : int = 20 ] [, $sort : string|null = null ] ) : ASResult
Parameters
$filters : array = null

主表条件

$mergeJoins : array = null

合并查询表

$subJoins : array|null = null

合并查询表(子集)

$page : int = 1

$size : int = 20

大小

$sort : string|null = null

排序

Return values
ASResult

advancedJoinList()

public advancedJoinList( [ $primaryParams : array = null ] [, $mergeJoins : array = null ] [, $subJoins : array = null ] [, $page : int = 1 ] [, $size : int = 20 ] [, $sort : string = null ] ) : mixed
Parameters
$primaryParams : array = null
$mergeJoins : array = null
$subJoins : array = null
$page : int = 1
$size : int = 20
$sort : string = null
Return values
mixed

beforeJoinList()

public beforeJoinList( [ &$primaryParams : array = null ] [, &$mergeJoins : array = null ] [, &$subJoins : array = null ] [, &$page : int = 1 ] [, &$size : int = 25 ] [, &$sort : string = null ] ) : mixed
Parameters
$primaryParams : array = null
$mergeJoins : array = null
$subJoins : array = null
$page : int = 1
$size : int = 25
$sort : string = null
Return values
mixed

beforeJoinListReturn()

public beforeJoinListReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

joinDetail()

多表联合详情 joinDetail

public joinDetail( $itemid : string [, $mergeJoins : array = null ] [, $subJoins : array|null = null ] ) : ASResult
Parameters
$itemid : string

索引ID

$mergeJoins : array = null

合并查询表

$subJoins : array|null = null

合并查询表(子集)

Return values
ASResult

beforeJoinDetail()

public beforeJoinDetail( &$itemid : string [, &$mergeJoins : array = null ] [, &$subJoins : array = null ] ) : mixed
Parameters
$itemid : string
$mergeJoins : array = null
$subJoins : array = null
Return values
mixed

beforeJoinDetailReturn()

public beforeJoinDetailReturn( &$result : ASResult ) : mixed
Parameters
$result : ASResult
Return values
mixed

fillJoinParams()

自动完善JOIN参数 fillJoinParams

public fillJoinParams( [ $joins : array|null = null ] [, $isSubJoin : bool = false ] ) : array
Parameters
$joins : array|null = null

初始参数

$isSubJoin : bool = false

是否使用子集结果

Return values
array

结果参数

search()

public search( $keyword : string [, $params : array = null ] [, $page : int = 1 ] [, $size : int = 25 ] [, $sort : string = null ] ) : mixed
Parameters
$keyword : string
$params : array = null
$page : int = 1
$size : int = 25
$sort : string = null
Return values
mixed

convert()

public convert( $params : array [, $struct : array = null ] ) : mixed
Parameters
$params : array
$struct : array = null
Return values
mixed

status()

设置状态 status

public status( $itemid : string , $status : string ) : ASResult
Parameters
$itemid : string
$status : string
Return values
ASResult

beforeStatus()

public beforeStatus( &$itemid : string , &$status : string ) : mixed
Parameters
$itemid : string
$status : string
Return values
mixed

block()

public block( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

trash()

public trash( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

sketch()

public sketch( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

offline()

public offline( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

online()

public online( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

recover()

public recover( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

done()

public done( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

expire()

public expire( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

pending()

public pending( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

pedding()

public pedding( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

setFeature()

public setFeature( $itemid : string [, $featured : int = 1 ] ) : mixed
Parameters
$itemid : string
$featured : int = 1
Return values
mixed

cancelFeature()

public cancelFeature( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

setSort()

public setSort( $itemid : string , $sort : int ) : mixed
Parameters
$itemid : string
$sort : int
Return values
mixed

increaseSort()

public increaseSort( $itemid : string [, $size : int = 1 ] ) : mixed
Parameters
$itemid : string
$size : int = 1
Return values
mixed

decreaseSort()

public decreaseSort( $itemid : string [, $size : int = 1 ] ) : mixed
Parameters
$itemid : string
$size : int = 1
Return values
mixed

view()

public view( $itemid : string [, $size : int = 1 ] ) : mixed
Parameters
$itemid : string
$size : int = 1
Return values
mixed

increase()

public increase( $field : string [, $conditions : mixed = null ] [, $size : int = 1 ] ) : mixed
Parameters
$field : string
$conditions : mixed = null
$size : int = 1
Return values
mixed

isStatus()

public isStatus( $itemid : string , $status : string ) : mixed
Parameters
$itemid : string
$status : string
Return values
mixed

isExist()

public isExist( $itemid : string ) : mixed
Parameters
$itemid : string
Return values
mixed

__construct()

ASObject constructor.

public __construct( ) : mixed
Return values
mixed

setTable()

protected setTable( $tableName : string ) : mixed
Parameters
$tableName : string
Return values
mixed

setId()

protected setId( $id : string ) : mixed
Parameters
$id : string
Return values
mixed

DBAdd()

添加数据到DB DBAdd

protected DBAdd( $params : array ) : mixed
Parameters
$params : array
Return values
mixed

DBAdds()

批量添加数据 DBAdds

protected DBAdds( $list : array ) : mixed
Parameters
$list : array
Return values
mixed

DBGet()

获取数据 DBGet

protected DBGet( $params : array ) : mixed
Parameters
$params : array
Return values
mixed

DBUpdate()

更新数据 Update to database

protected DBUpdate( $params : array , $conditions : string ) : mixed
Parameters
$params : array

[数据k-v]

$conditions : string

[description]

Return values
mixed

DBUpdates()

批量更新数据 DBUpdates

protected DBUpdates( $list : array , $keyField : string , $conditions : string ) : mixed
Parameters
$list : array

数据列表 Array of K-V

$keyField : string

筛选字段

$conditions : string

筛选条件

Return values
mixed

DBRemove()

从数据库中删除行 DBRemove

protected DBRemove( $conditions : array|string ) : mixed
Parameters
$conditions : array|string
Return values
mixed

DBCount()

统计数据库中对应行数 Count valid rows with conditions

protected DBCount( $conditions : array|string ) : mixed
Parameters
$conditions : array|string
Return values
mixed

DBCheck()

在数据库中检测字段是否是对应数据 Check data is valid at field

protected DBCheck( $field : string , $value : mixed , $conditions : array|string [, $sort : string = "createtime DESC" ] ) : mixed
Parameters
$field : string

字段名

$value : mixed

数据值

$conditions : array|string

查询条件

$sort : string = "createtime DESC"

排序 默认创建时间倒序

Return values
mixed

DBNatureCount()

基于自然语言关键词查询计数 DBNatureCount

protected DBNatureCount( $conditions : array|string , $keyword : string ) : mixed
Parameters
$conditions : array|string

查询条件

$keyword : string

关键词

Return values
mixed

DBNatureGet()

基于自然语言关键词查询 Get data with nature language keyword search

protected DBNatureGet( $conditions : array|string , $keyword : string ) : mixed
Parameters
$conditions : array|string

查询条件

$keyword : string

关键词

Return values
mixed

DBJoinCount()

联合查询计数 DBJoinCount

protected DBJoinCount( $primaryParams : array , $joinParams : array ) : mixed
Parameters
$primaryParams : array
$joinParams : array
Return values
mixed

DBJoinGet()

联合查询 DBJoinGet

protected DBJoinGet( $primaryParams : array , $joinParams : array [, $page : int = 1 ] [, $size : int = 20 ] [, $sort : string|null = null ] ) : mixed
Parameters
$primaryParams : array
$joinParams : array
$page : int = 1
$size : int = 20
$sort : string|null = null
Return values
mixed

record()

记录日志到数据 Make a record to DB

protected record( [ $event : string = null ] [, $sign : string = null ] ) : mixed
Parameters
$event : string = null

事件名称 Event name

$sign : string = null

程序签名 Sign by methods

Return values
mixed

take()

设置主体别称 Alias of setContent

public take( $content : ) : $this
Parameters
$content :
Return values
$this

setContent()

设置结果包装中的主数据 set content of result

public setContent( $content : ) : mixed
Parameters
$content :
Return values
mixed

sign()

设置方法签名 Set method sign

public sign( $sign : ) : mixed
Parameters
$sign :
Return values
mixed

feedback()

返回结果 通用 Returning result to the caller

public feedback( [ $status : int|null = null ] [, $message : string|null = null ] [, $sign : string|null = null ] ) : ASResult
Parameters
$status : int|null = null
$message : string|null = null
$sign : string|null = null
Return values
ASResult

error()

返回错误 Returning Error result

public error( $status : int , $message : string [, $sign : string|null = null ] ) : ASResult
Parameters
$status : int
$message : string
$sign : string|null = null
Return values
ASResult

success()

返回成功 Return Success result

public success( [ $message : string|null = null ] [, $sign : string|null = null ] ) : ASResult
Parameters
$message : string|null = null
$sign : string|null = null
Return values
ASResult

Search results