PHP Класс Swoole\Model

Автор: Tianfeng Han
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$_data
$_form
$_form_secret
$_struct
$create_sql
$db swoole\IDatabase
$fields
$foreignkey
$if_cache
$primary
$select
$swoole
$table
$tablesize integer 表切片参数

Защищенные свойства (Protected)

Свойство Тип Описание
$_table_before_shard

Открытые методы

Метод Описание
__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切分表

Описание методов

__construct() публичный Метод

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

all() публичный Метод

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

checkForm() публичный Метод

public checkForm ( $input, $method, string &$error ) : true
$error string 出错时设置
Результат true or false

count() публичный Метод

返回符合条件的记录数
public count ( array $params ) : true/false
$params array
Результат true/false

createTable() публичный Метод

建立表,必须在Model类中,指定create_sql
public createTable ( ) : boolean
Результат boolean

del() публичный Метод

删除一条数据主键为$id的记录,
public del ( $id, $where = null ) : true/false
$id
$where string 指定匹配字段,默认为主键
Результат true/false

dels() публичный Метод

删除一条数据包含多个参数
public dels ( $params ) : boolean
$params
Результат boolean

desc() публичный Метод

获取表的字段描述
public desc ( ) : array
Результат array

exists() публичный Метод

检测是否存在数据,实际可以用count代替,0为false,>0为true
public exists ( $gets ) : boolean
$gets
Результат boolean

get() публичный Метод

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

getForm() публичный Метод

自动生成表单
public getForm ( $set_id ) : unknown_type
$set_id
Результат unknown_type

getList() публичный Метод

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

getMap() публичный Метод

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

getStatus() закрытый публичный Метод

获取表状态
final public getStatus ( ) : array
Результат array 表的status,包含了自增ID,计数器等状态数据

getTree() публичный Метод

获取一个2层的树状结构
public getTree ( $gets, $category = 'fid', $order = 'id desc' ) : unknown_type
$gets
$category
$order
Результат unknown_type

gets() публичный Метод

获取表的一段数据,查询的参数由$params指定
public gets ( $params, &$pager = null ) : array
$params
$pager Pager
Результат array

parseForm() публичный Метод

public parseForm ( )

put() публичный Метод

插入一条新的记录到表
public put ( $data ) : integer
$data Array 必须是键值(表的字段对应值)对应
Результат integer

set() публичный Метод

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

sets() публичный Метод

更新一组数据
public sets ( array $data, array $params ) : boolean
$data array 更新的数据
$params array update的参数列表
Результат boolean

shard_table() публичный Метод

按ID切分表
public shard_table ( $id ) : null
$id
Результат null

Описание свойств

$_data публичное свойство

public $_data

$_form публичное свойство

public $_form

$_form_secret публичное свойство

public $_form_secret

$_struct публичное свойство

public $_struct

$_table_before_shard защищенное свойство

protected $_table_before_shard

$create_sql публичное свойство

public $create_sql

$db публичное свойство

public IDatabase,swoole $db
Результат swoole\IDatabase

$fields публичное свойство

public $fields

$foreignkey публичное свойство

public $foreignkey

$if_cache публичное свойство

public $if_cache

$primary публичное свойство

public $primary

$select публичное свойство

public $select

$swoole публичное свойство

public $swoole

$table публичное свойство

public $table

$tablesize публичное свойство

表切片参数
public int $tablesize
Результат integer