PHP Class Swoole\Model

Author: Tianfeng Han
显示文件 Open project: matyhtf/swoole_framework Class Usage Examples

Public Properties

Property Type Description
$_data
$_form
$_form_secret
$_struct
$create_sql
$db swoole\IDatabase
$fields
$foreignkey
$if_cache
$primary
$select
$swoole
$table
$tablesize integer 表切片参数

Protected Properties

Property Type Description
$_table_before_shard

Public Methods

Method Description
__construct ( Swoole $swoole, string $db_key = 'master' ) 构造函数
all ( ) : RecordSet 获取到所有表记录的接口,通过这个接口可以访问到数据库的记录
checkForm ( $input, $method, string &$error ) : true
count ( array $params ) : true/false 返回符合条件的记录数
createTable ( ) : boolean 建立表,必须在Model类中,指定create_sql
del ( $id, $where = null ) : true/false 删除一条数据主键为$id的记录,
dels ( $params ) : boolean 删除一条数据包含多个参数
desc ( ) : array 获取表的字段描述
exists ( $gets ) : boolean 检测是否存在数据,实际可以用count代替,0为false,>0为true
get ( $object_id, $where = '' ) : Record 获取主键$primary_key为$object_id的一条记录对象(Record Object) 如果参数为空的话,则返回一条空白的Record,可以赋值,产生一条新的记录
getForm ( $set_id ) : unknown_type 自动生成表单
getList ( &$params, $get = 'data' ) : array 获取一个数据列表,功能类似于gets,此方法仅用于SiaoCMS,不作为同样类库的方法
getMap ( $gets, $field = null ) : array 获取一个键值对应的结构,键为表记录主键的值,值为记录数据或者其中一个字段的值
getStatus ( ) : array 获取表状态
getTree ( $gets, $category = 'fid', $order = 'id desc' ) : unknown_type 获取一个2层的树状结构
gets ( $params, &$pager = null ) : array 获取表的一段数据,查询的参数由$params指定
parseForm ( )
put ( $data ) : integer 插入一条新的记录到表
set ( $id, $data, $where = '' ) : boolean 更新ID为$id的记录,值为$data关联数组
sets ( array $data, array $params ) : boolean 更新一组数据
shard_table ( $id ) : null 按ID切分表

Method Details

__construct() public method

构造函数
public __construct ( Swoole $swoole, string $db_key = 'master' )
$swoole Swoole
$db_key string 选择哪个数据库

all() public method

获取到所有表记录的接口,通过这个接口可以访问到数据库的记录
public all ( ) : RecordSet
return RecordSet Object (这是一个接口,不包含实际的数据)

checkForm() public method

public checkForm ( $input, $method, string &$error ) : true
$error string 出错时设置
return true or false

count() public method

返回符合条件的记录数
public count ( array $params ) : true/false
$params array
return true/false

createTable() public method

建立表,必须在Model类中,指定create_sql
public createTable ( ) : boolean
return boolean

del() public method

删除一条数据主键为$id的记录,
public del ( $id, $where = null ) : true/false
$id
$where string 指定匹配字段,默认为主键
return true/false

dels() public method

删除一条数据包含多个参数
public dels ( $params ) : boolean
$params
return boolean

desc() public method

获取表的字段描述
public desc ( ) : array
return array

exists() public method

检测是否存在数据,实际可以用count代替,0为false,>0为true
public exists ( $gets ) : boolean
$gets
return boolean

get() public method

获取主键$primary_key为$object_id的一条记录对象(Record Object) 如果参数为空的话,则返回一条空白的Record,可以赋值,产生一条新的记录
public get ( $object_id, $where = '' ) : Record
$object_id
$where
return Record Object

getForm() public method

自动生成表单
public getForm ( $set_id ) : unknown_type
$set_id
return unknown_type

getList() public method

获取一个数据列表,功能类似于gets,此方法仅用于SiaoCMS,不作为同样类库的方法
public getList ( &$params, $get = 'data' ) : array
$params
$get
return array

getMap() public method

获取一个键值对应的结构,键为表记录主键的值,值为记录数据或者其中一个字段的值
public getMap ( $gets, $field = null ) : array
$gets
$field
return array

getStatus() final public method

获取表状态
final public getStatus ( ) : array
return array 表的status,包含了自增ID,计数器等状态数据

getTree() public method

获取一个2层的树状结构
public getTree ( $gets, $category = 'fid', $order = 'id desc' ) : unknown_type
$gets
$category
$order
return unknown_type

gets() public method

获取表的一段数据,查询的参数由$params指定
public gets ( $params, &$pager = null ) : array
$params
$pager Pager
return array

parseForm() public method

public parseForm ( )

put() public method

插入一条新的记录到表
public put ( $data ) : integer
$data Array 必须是键值(表的字段对应值)对应
return integer

set() public method

更新ID为$id的记录,值为$data关联数组
public set ( $id, $data, $where = '' ) : boolean
$id
$data
$where string 指定匹配字段,默认为主键
return boolean

sets() public method

更新一组数据
public sets ( array $data, array $params ) : boolean
$data array 更新的数据
$params array update的参数列表
return boolean

shard_table() public method

按ID切分表
public shard_table ( $id ) : null
$id
return null

Property Details

$_data public_oe property

public $_data

$_form public_oe property

public $_form

$_form_secret public_oe property

public $_form_secret

$_struct public_oe property

public $_struct

$_table_before_shard protected_oe property

protected $_table_before_shard

$create_sql public_oe property

public $create_sql

$db public_oe property

public IDatabase,swoole $db
return swoole\IDatabase

$fields public_oe property

public $fields

$foreignkey public_oe property

public $foreignkey

$if_cache public_oe property

public $if_cache

$primary public_oe property

public $primary

$select public_oe property

public $select

$swoole public_oe property

public $swoole

$table public_oe property

public $table

$tablesize public_oe property

表切片参数
public int $tablesize
return integer