abstract class Base implements Db

Orm 数据库抽象基类

Properties

static protected array $dbInst 多个Model中共享db连接实例
protected bool $openCache 启用数据缓存
protected bool $currentQueryUseCache 单独标记当前的query使不使用缓存
protected int $whereNeedAddAndOrOr where操作需要加上and/or 0 : 初始化两个都不加 1 : 要加and 2: 要加 or
protected array $bindParams 执行sql时绑定的参数
protected array $conf 配置信息
string $tablePrefix 表前缀方便外部读取
protected array $sql sql组装
protected array $table 操作的表
protected array $join 是否内联 [表名 => 条件]
protected array $leftJoin 是否左联结 写法同内联
protected array $rightJoin 是否右联 写法同内联
protected string $union UNION 写法同内联
protected bool $paramsAutoReset orm参数是否自动重置
protected bool $alwaysClearTable $paramsAutoReset = false 的时候是否清除table.避免快捷方法重复调用table();
protected bool $alwaysClearColumns $paramsAutoReset = false 的时候是否清除查询的字段信息.主要用于按批获取数据不用多次调用columns();

Methods

$this
table(string|array $table = '', mixed $tablePrefix = null)

定义操作的表

resource|false
__get(string $db)

魔术方法 自动获取相应db实例

bool|false|mixed|resource
connectDb(string $db, bool $reConnect = false)

连接数据库

array
paginate(int $limit, bool $useMaster = false, null|int $page = null)

分页获取数据

string
getPk(string $table, string $tablePrefix = null)

获取表主键

array
getOne(bool $useMaster = false)

获取一条数据

bool|mixed
getOneValue(string $column, bool $useMaster = false)

获取一列

array
plunk(string $column, null $key = null, int $limit = null, bool $useMaster = false)

获取数据列值列表

chunk(int $num = 100, callable $func)

组块结果集-此方法前调用paramsAutoReset无效

$this
where(string|array $column, string $value = '')

where条件组装 相等

$this
whereColumn(string $column, string $column2)

where条件组装 两个列相等

$this
whereRaw(string $where, array $params)

where条件原生条件

$this
when(bool $condition, callable $trueCallback, callable $falseCallback = null)

根据条件是否成立执行对应的闭包

$this
whereNot(string $column, string $value)

where条件组装 不等

$this
whereGt(string $column, string $value)

where条件组装 大于

$this
whereLt(string $column, string $value)

where条件组装 小于

$this
whereGte(string $column, string $value)

where条件组装 大于等于

$this
whereLte(string $column, string $value)

where条件组装 小于等于

$this
whereIn(string $column, array $value)

where条件组装 in

$this
whereNotIn(string $column, array $value)

where条件组装 not in

$this
whereRegExp(string $column, string $value)

where条件组装 REGEXP

$this
whereLike(string $column, bool $leftBlur = false, string $value, bool $rightBlur = false)

where条件组装 LIKE

$this
whereNotLike(string $column, bool $leftBlur = false, string $value, bool $rightBlur = false)

where条件组装 LIKE

string
filterLike(string $val)

where 用户输入过滤

$this
whereBetween(string $column, string $value, string $value2 = null)

where条件组装 BETWEEN

$this
whereNotBetween(string $column, string $value, string $value2 = null)

where条件组装 NOT BETWEEN

$this
whereNull(string $column)

where条件组装 IS NULL

$this
whereNotNull(string $column)

where条件组装 IS NOT NULL

$this
conditionFactory(string $column, array|int|string $value, string $operator = '=')

where 语句组装工厂

$this
_and(callable $callable = null)

增加 and条件操作符

$this
_or(callable $callable = null)

增加or条件操作符

$this
lBrackets()

where条件增加左括号

$this
rBrackets()

where条件增加右括号

$this
columns(string|array $columns = '*')

选择列

$this
limit(int $offset = 0, int $limit = 10)

LIMIT

$this
orderBy(string $column, string $order = 'ASC')

排序

$this
groupBy(string $column)

分组

$this
having(string $column, string $operator = '=', string $value, string $logic = 'AND')

having语句

$this
join(string|array $table, string $on, mixed $tablePrefix = null)

join内联结

$this
leftJoin(string|array $table, string $on, mixed $tablePrefix = null)

leftJoin左联结

$this
rightJoin(string|array $table, string $on, mixed $tablePrefix = null)

rightJoin右联结

$this
union(string|array $sql, bool $all = false)

union联结

filterUnionSql($sql)

No description

string
parseOn(string $table, array $on)

解析联结的on参数

$this
paramsAutoReset(bool $autoReset = true, bool $alwaysClearTable = false, bool $alwaysClearColumns = true)

orm参数是否自动重置, 默认在执行语句后会重置orm参数,包含查询的表、字段信息、条件等信息

reset(bool $must = false)

orm参数重置

clearBindParams()

清空绑定的参数

$this
resetAndClear()

重置所有orm参数及绑定

string
arrToCondition(array $arr)

SQL语句条件组装

array
parseKey(string $key, bool $and = true, bool $noCondition = false, bool $noTable = false)

SQL语句条件组装

mixed
getCacheVer(string $table)

根据表名获取cache版本号

$this
noCache()

标记本次查询不使用缓存

setCacheVer(string $table)

设置cache版本号

bool
transaction(callable $query)

执行

__destruct()

析构函数

Details

at line 159
$this table(string|array $table = '', mixed $tablePrefix = null)

定义操作的表

Parameters

string|array $table 表名 要取别名时使用 [不带前缀表名 => 别名]
mixed $tablePrefix 表前缀 不传则获取配置中配置的前缀

Return Value

$this

at line 176
resource|false __get(string $db)

魔术方法 自动获取相应db实例

Parameters

string $db 要连接的数据库类型

Return Value

resource|false 数据库 连接标识

at line 192
protected bool|false|mixed|resource connectDb(string $db, bool $reConnect = false)

连接数据库

Parameters

string $db rlink/wlink
bool $reConnect 是否重连--用于某些db如mysql.长连接被服务端断开的情况

Return Value

bool|false|mixed|resource

at line 240
array paginate(int $limit, bool $useMaster = false, null|int $page = null)

分页获取数据

Parameters

int $limit 每页返回的条数
bool $useMaster 是否使用主库 默认读取从库
null|int $page 当前页数-不传则获取配置中var_page配置的request值

Return Value

array

at line 255
string getPk(string $table, string $tablePrefix = null)

获取表主键

Parameters

string $table 要获取主键的表名
string $tablePrefix 表前缀

Return Value

string || false

at line 274
array getOne(bool $useMaster = false)

获取一条数据

Parameters

bool $useMaster 是否使用主库 默认读取从库

Return Value

array | bool

at line 292
bool|mixed getOneValue(string $column, bool $useMaster = false)

获取一列

Parameters

string $column 列名
bool $useMaster 是否使用主库 默认读取从库

Return Value

bool|mixed

at line 309
array plunk(string $column, null $key = null, int $limit = null, bool $useMaster = false)

获取数据列值列表

Parameters

string $column 列名
null $key 返回数组中为列值指定自定义键(该自定义键必须是该表的其它字段列名)
int $limit 返回的条数
bool $useMaster 是否使用主库 默认读取从库

Return Value

array

at line 326
chunk(int $num = 100, callable $func)

组块结果集-此方法前调用paramsAutoReset无效

Parameters

int $num 每次获取的条数
callable $func 结果集处理函数

at line 363
$this where(string|array $column, string $value = '')

where条件组装 相等

Parameters

string|array $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名) 当$column为数组时 批量设置
string $value |int $value 当$column为数组时 此时$value为false时条件为or 否则为and

Return Value

$this

at line 384
$this whereColumn(string $column, string $column2)

where条件组装 两个列相等

Parameters

string $column eg:username | user.username
string $column2 eg: nickname | user.nickname

Return Value

$this

at line 398
$this whereRaw(string $where, array $params)

where条件原生条件

Parameters

string $where eg:utime > ctime + ?
array $params eg: [10]

Return Value

$this

at line 413
$this when(bool $condition, callable $trueCallback, callable $falseCallback = null)

根据条件是否成立执行对应的闭包

Parameters

bool $condition 条件
callable $trueCallback 条件成立执行的闭包
callable $falseCallback 条件不成立执行的闭包

Return Value

$this

at line 431
$this whereNot(string $column, string $value)

where条件组装 不等

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int $value

Return Value

$this

at line 445
$this whereGt(string $column, string $value)

where条件组装 大于

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int $value

Return Value

$this

at line 459
$this whereLt(string $column, string $value)

where条件组装 小于

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int $value

Return Value

$this

at line 473
$this whereGte(string $column, string $value)

where条件组装 大于等于

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int $value

Return Value

$this

at line 487
$this whereLte(string $column, string $value)

where条件组装 小于等于

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int $value

Return Value

$this

at line 501
$this whereIn(string $column, array $value)

where条件组装 in

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
array $value

Return Value

$this

at line 515
$this whereNotIn(string $column, array $value)

where条件组装 not in

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
array $value [1,2,3]

Return Value

$this

at line 529
$this whereRegExp(string $column, string $value)

where条件组装 REGEXP

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int $value

Return Value

$this

at line 545
$this whereLike(string $column, bool $leftBlur = false, string $value, bool $rightBlur = false)

where条件组装 LIKE

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
bool $leftBlur 是否开始左模糊匹配
string $value |int $value
bool $rightBlur 是否开始右模糊匹配

Return Value

$this

at line 565
$this whereNotLike(string $column, bool $leftBlur = false, string $value, bool $rightBlur = false)

where条件组装 LIKE

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
bool $leftBlur 是否开始左模糊匹配
string $value |int $value
bool $rightBlur 是否开始右模糊匹配

Return Value

$this

at line 582
protected string filterLike(string $val)

where 用户输入过滤

Parameters

string $val

Return Value

string

at line 596
$this whereBetween(string $column, string $value, string $value2 = null)

where条件组装 BETWEEN

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int | array $value
string $value2 |int | null $value2

Return Value

$this

at line 619
$this whereNotBetween(string $column, string $value, string $value2 = null)

where条件组装 NOT BETWEEN

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
string $value |int | array $value
string $value2 |int | null $value2

Return Value

$this

at line 640
$this whereNull(string $column)

where条件组装 IS NULL

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)

Return Value

$this

at line 653
$this whereNotNull(string $column)

where条件组装 IS NOT NULL

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)

Return Value

$this

at line 668
$this conditionFactory(string $column, array|int|string $value, string $operator = '=')

where 语句组装工厂

Parameters

string $column 如 id user.id (这边的user为表别名如表pre_user as user 这边用user而非带前缀的原表名)
array|int|string $value
string $operator 操作符

Return Value

$this

at line 722
$this _and(callable $callable = null)

增加 and条件操作符

Parameters

callable $callable 如果传入函数则函数内执行的条件会被()包围

Return Value

$this

at line 744
$this _or(callable $callable = null)

增加or条件操作符

Parameters

callable $callable 如果传入函数则函数内执行的条件会被()包围

Return Value

$this

at line 764
$this lBrackets()

where条件增加左括号

Return Value

$this

at line 786
$this rBrackets()

where条件增加右括号

Return Value

$this

at line 800
$this columns(string|array $columns = '*')

选择列

Parameters

string|array $columns 默认选取所有 ['id, 'name'] 选取id,name两列,['article.id' => 'aid', 'article.title' => 'article_title'] 别名

Return Value

$this

at line 823
$this limit(int $offset = 0, int $limit = 10)

LIMIT

Parameters

int $offset 偏移量
int $limit 返回的条数

Return Value

$this

at line 841
$this orderBy(string $column, string $order = 'ASC')

排序

Parameters

string $column 要排序的字段
string $order 方向,默认为正序

Return Value

$this

at line 858
$this groupBy(string $column)

分组

Parameters

string $column 要设置分组的字段名

Return Value

$this

at line 878
$this having(string $column, string $operator = '=', string $value, string $logic = 'AND')

having语句

Parameters

string $column 字段名
string $operator 操作符
string $value
string $logic 逻辑AND OR

Return Value

$this

at line 902
$this join(string|array $table, string $on, mixed $tablePrefix = null)

join内联结

Parameters

string|array $table 表名 要取别名时使用 [不带前缀表名 => 别名]
string $on 联结的条件 如:'c.cid = a.cid'
mixed $tablePrefix 表前缀

Return Value

$this

at line 923
$this leftJoin(string|array $table, string $on, mixed $tablePrefix = null)

leftJoin左联结

Parameters

string|array $table 表名 要取别名时使用 [不带前缀表名 => 别名]
string $on 联结的条件 如:'c.cid = a.cid'
mixed $tablePrefix 表前缀

Return Value

$this

at line 944
$this rightJoin(string|array $table, string $on, mixed $tablePrefix = null)

rightJoin右联结

Parameters

string|array $table 表名 要取别名时使用 [不带前缀表名 => 别名]
string $on 联结的条件 如:'c.cid = a.cid'
mixed $tablePrefix 表前缀

Return Value

$this

at line 964
$this union(string|array $sql, bool $all = false)

union联结

Parameters

string|array $sql 要union的sql
bool $all 是否为union all

Return Value

$this

at line 978
protected filterUnionSql($sql)

Parameters

$sql

at line 995
protected string parseOn(string $table, array $on)

解析联结的on参数

Parameters

string $table 要联结的表名
array $on ['on条件1', 'on条件2' => true] on条件为数字索引时多条件默认为and为非数字引时 条件=>true为and 条件=>false为or

Return Value

string

at line 1022
$this paramsAutoReset(bool $autoReset = true, bool $alwaysClearTable = false, bool $alwaysClearColumns = true)

orm参数是否自动重置, 默认在执行语句后会重置orm参数,包含查询的表、字段信息、条件等信息

Parameters

bool $autoReset 是否自动重置 查询的表、字段信息、条件等信息
bool $alwaysClearTable 用来控制在$paramsAutoReset = false 的时候是否清除查询的table信息.避免快捷方法重复调用table();
bool $alwaysClearColumns 用来控制在$paramsAutoReset = false 的时候是否清除查询的字段信息.主要用于按批获取数据不用多次调用columns();

Return Value

$this

at line 1036
reset(bool $must = false)

orm参数重置

Parameters

bool $must 是否强制重置

at line 1070
protected clearBindParams()

清空绑定的参数

at line 1082
$this resetAndClear()

重置所有orm参数及绑定

Return Value

$this

at line 1096
protected string arrToCondition(array $arr)

SQL语句条件组装

Parameters

array $arr 要组装的数组

Return Value

string

at line 1154
protected array parseKey(string $key, bool $and = true, bool $noCondition = false, bool $noTable = false)

SQL语句条件组装

Parameters

string $key eg: 'forum-fid-1-uid-2'
bool $and 多个条件之间是否为and true为and false为or
bool $noCondition 是否为无条件操作 set/delete/update操作的时候 condition为空是正常的不报异常
bool $noTable 是否可以没有数据表 当delete/update等操作的时候已经执行了table() table为空是正常的

Return Value

array eg: ['forum', "fid = '1' AND uid = '2'"]

at line 1181
mixed getCacheVer(string $table)

根据表名获取cache版本号

Parameters

string $table

Return Value

mixed

at line 1200
$this noCache()

标记本次查询不使用缓存

Return Value

$this

at line 1211
setCacheVer(string $table)

设置cache版本号

Parameters

string $table

at line 1235
bool transaction(callable $query)

执行

Parameters

callable $query

Return Value

bool

at line 1246
__destruct()

析构函数