BeaconPHP 帮助文档

BeaconPHP V3.x

DBSelector 类

DBSelector 类是一个数据库查询器，为了方便数据库查询而设计的。

__construct(string $table)

构造函数
$table 数据表名同样的使用 @pf_ 替代数据库表名前缀。

use beacon\core\DBSelector;
$selector = new DBSelector('@pf_article');
$list = $selector->getList();
print_r($list);

同时表名也可以支持别名。

$selector = new DBSelector('@pf_article A');
$selector->field('A.*,B.name as categoryName');
$selector->innerJoin('@pf_category B')->joinOn('B.id=A.categoryId');
$list = $selector->getList();
print_r($list);

只能支持1个表名，不可以支持多个表名。
也可以是一个表达式表名

$selector = new DBSelector('(select id,title,categoryId from @pf_article) as A');
$selector->field('A.*,B.name as categoryName');
$selector->innerJoin('@pf_category B')->joinOn('B.id=A.categoryId');
$list = $selector->getList();

field(string $fields, array|string|int|float|bool|null $args = null): static

查询的字段信息
$fields 是需要查询的字段默认是 *

$args 是参数站位符的替换数组，如果只有1个可以直接填写，多个需要使用[] 数组包括起来。

$selector = new DBSelector('@pf_article as A');
$selector->field('A.*,B.name as categoryName');
$selector->innerJoin('@pf_category B')->joinOn('B.id=A.categoryId');

#field 带有子查询，且带有1个参数
$selector = new DBSelector('@pf_article A');
$selector->field('A.*,(select name from @pf_category where id=A.categoryId) as categoryName,? as kind',2);
$list = $selector->getList();
print_r($list);

#field 带有子查询，且带有多个参数，参数用数组包括起来 []
$selector = new DBSelector('@pf_article A');
$selector->field('A.*,(select name from @pf_category where id=A.categoryId and allow=?) as categoryName,? as kind',[1,2]);
$list = $selector->getList();
print_r($list);

limit(int $offset = 0, int $size = 0): static

限制返回条数

$offset 起始偏移数

$size 返回条数

$selector = new DBSelector('@pf_article A');
$selector->field('A.id,(select name from @pf_category where id=A.categoryId and allow=?) as categoryName,? as kind',[1,2]);
$selector->limit(0,3);
$list = $selector->getList();
print_r($list);

order(string $order, array|string|int|float|bool|null $args = null): static

排序
$order 排序条件

$args 是参数站位符的替换数组，如果只有1个可以直接填写，多个需要使用[] 数组包括起来。

$selector = new DBSelector('@pf_article A');
$selector->field('A.id,(select name from @pf_category where id=A.categoryId and allow=?) as categoryName,? as kind',[1,2]);
$selector->order('A.sort desc,A.id desc');

#使用到参数的场景示例
$selector = new DBSelector('@pf_article');
$selector->order('case categoryId when ? then 1 when ? then 2 else 3 end desc',[0,1]);

where(string|SqlCondition $sql = '', array|string|int|float|bool|null $args = null): static

查询条件
$sql 查询条件
$args 查询参数，如果只有1个可以直接填写，多个可以使用[]数组包括起来。

$selector = new DBSelector('@pf_article');
$selector->where('allow=?', 1);
$selector->where('(categoryId=? or categoryId=?)', [1, 2]);
$list = $selector->getList();

$selector = new DBSelector('(select id,title,allow,categoryId from @pf_article) as A');
$selector->field('A.*,B.name as categoryName');
$selector->innerJoin('@pf_category B')->joinOn('B.id=A.categoryId');
$selector->where('A.allow=?', 1);
$selector->where('(B.id=? or B.id=?)', [1, 2]);
$list = $selector->getList();

$selector = new DBSelector('(select id,title,allow,categoryId from @pf_article) as A');
$selector->field('A.*,B.name as categoryName');
$selector->innerJoin('@pf_category B')->joinOn('B.id=A.categoryId');
$selector->where('A.allow=?', 1);

$where = new SqlCondition();
$where->where('B.id=? or B.id=?', [1,2]);
#查询条件片段
$selector->where($where);

$list = $selector->getList();
print_r($list);

search(string $sql, array|string|int|float|bool|null $value, int $type = self::WITHOUT_EMPTY): static

搜索数据，与查询 where 不同的是 search 每次只处理1项数据。
$sql 查询的条件
$value 要查询的值，只能有一个值。如果占位符‘?’有多个，将使用这个值替换所有占位符'?' ,如果 $sql 存在 '[?]' 占位符，则 $value 应该为数组并展开替换一般用于 in 和 not in
$type 过滤类型。

const WITHOUT_EMPTY = 0;            #过滤 null,'',0,'0',false 
const WITHOUT_NULL = 1;             #仅过滤 null
const WITHOUT_ZERO_LENGTH = 2;      #过滤 null,''
const WITHOUT_ZERO = 3;             #过滤 null,0,'0',false 但是不过滤 ''

被过滤的 $value 不会加入查询条件中。
[?] 占位符只有 search 支持。

$selector = new DBSelector('@pf_article');
$selector->where('allow=? and columnId=?', [1, 2]);
$categoryId = '';
#如果 $categoryId 为空 则 search 不会把 categoryId=? 加入到查询中，如果 categoryId 有值则会加入查询。
# 比如 我们的 $categoryId 是列表搜索字段，如果没有传值则不加入查询 0,'0',false,null,'' 也会被认为是空.
$selector->search('categoryId=?', $categoryId);
$sqlItem = $selector->buildSql();
print_r($sqlItem->format());
#结果
#select * from `@pf_article` where allow=1 and columnId=2
#如果  $categoryId='3'; 即有值 结果为：
#select * from `@pf_article` where allow=1 and columnId=2 and categoryId='3'

使用 [?] 占位符

$selector = new DBSelector('@pf_article');
$selector->where('allow=? and columnId=?', [1, 2]);
#使用数组占位符 [?] 一般用于 in  not in
$selector->search('id in ([?])', [1,2,3,4,5]);
$sqlItem = $selector->buildSql();
print_r($sqlItem->format());
#结果：
# select * from `@pf_article` where allow=1 and columnId=2 and id in (1,2,3,4,5)

# 多个占位符会使用同一个值替换所有占位符。

$selector = new DBSelector('@pf_article');
$selector->where('allow=? and columnId=?', [1, 2]);
#多个占位符，都使用同一个值替换，这与where 是不同的。
$selector->search('(beginTime > ? and endTime < ?)', '2021-01-01 00:00:00');
$sqlItem = $selector->buildSql();
print_r($sqlItem->format());
#结果
#select * from `@pf_article` where allow=1 and columnId=2 and (beginTime > '2021-01-01 00:00:00' and endTime <'2021-01-01 00:00:00')

#字符串 like 匹配查询示例

$selector = new DBSelector('@pf_member');

$name  =  Request::param('name');
$mobile  = Request::param('mobile');

$selector->search('(`username` like concat(\'%\',?,\'%\') or `name` like concat(\'%\',?,\'%\'))', $name , DBSelector::WITHOUT_ZERO_LENGTH);
$selector->search('`mobile` like concat(\'%\',?,\'%\')', $mobile , DBSelector::WITHOUT_ZERO_LENGTH);
$selector->order('id desc');

group(string $group, array|string|int|float|bool|null $args = null): static

归组聚合查询
$group 为聚合查询的归组条件。
$args 是参数站位符的替换数组，如果只有1个可以直接填写，多个需要使用[] 数组包括起来。

$selector = new DBSelector('@pf_article');
$selector->field('columnId,categoryId,count(1) as myCount,sum(hits) as myHits');
$selector->group('columnId,categoryId');

$sqlItem = $selector->buildSql();
print_r($sqlItem->format());
#结果是
#select columnId,categoryId,count(1) as myCount,sum(hits) as myHits from `@pf_article` group by columnId,categoryId

用到参数的 group

$selector = new DBSelector('@pf_article');
$selector->field('count(1) as myCount,sum(hits) as myHits');
#使用到参数的归类查询
$selector->group('case categoryId when ? then ? else ? end', [0, '空', '有']);

$sqlItem = $selector->buildSql();
print_r($sqlItem->format());
#输出结果是：
#select count(1) as myCount,sum(hits) as myHits from `@pf_article` group by case categoryId when 0 then '空' else '有' end

having(string $sql, array|string|int|float|bool|null $args = null): static

对结果集的二次查询

$sql 查询条件
$args 查询参数，如果只有1个可以直接填写，多个可以使用[]数组包括起来。

$selector = new DBSelector('@pf_article');
$selector->field('count(1) as myCount,sum(hits) as myHits');
$selector->group('case categoryId when ? then ? else ? end', [0, '空', '有']);
#对结果集进行二次查询
$selector->having('myHits>?', 3000);
$sqlItem = $selector->buildSql();
print_r($sqlItem->format());
#输出结果：
#select count(1) as myCount,sum(hits) as myHits from `@pf_article` group by case categoryId when 0 then '空' else '有' end having myHits>3000

leftJoin(string $table, array|string|int|float|bool|null $args = null): static

rightJoin(string $table, array|string|int|float|bool|null $args = null): static

innerJoin(string $table, array|string|int|float|bool|null $args = null): static

outerJoin(string $table, array|string|int|float|bool|null $args = null): static

fullJoin(string $table, array|string|int|float|bool|null $args = null): static

联表查询
$table 要链接的表
$args 是参数站位符的替换数组，如果只有1个可以直接填写，多个需要使用[] 数组包括起来。

$selector = new DBSelector('@pf_article A');
$selector->field('A.id,ifnull(B.name,?) as categoryName,C.name as columnName', '--');
$selector->leftJoin('@pf_category B')->joinOn('B.id=A.categoryId and B.allow=?', 1);
$selector->innerJoin('(select id,name from @pf_column where allow=?) C', 1)->joinOn('C.id=A.columnId');
$sqlItem = $selector->buildSql();
print_r($sqlItem->format());

#输出结果
/*
select A.id,ifnull(B.name,'--') as categoryName,C.name as columnName from `@pf_article` A
left join @pf_category B on B.id=A.categoryId and B.allow=1 
inner join (select id,name from @pf_column where allow=1) C on C.id=A.columnId
*/

joinOn(string $sql, array|string|int|float|bool|null $args = null): static

联表的条件
$sql 条件语句
$args 是参数站位符的替换数组，如果只有1个可以直接填写，多个需要使用[] 数组包括起来。

一般尾随 leftJoin rightJoin innerJoin outerJoin fullJoin 执行。

union(string|DBSelector $sql, array|string|int|float|bool|null $args = null): static

unionAll(string|DBSelector $sql, array|string|int|float|bool|null $args = null): static

联合查询
$sql 条件语句，或者查询器
$args 是参数站位符的替换数组，如果只有1个可以直接填写，多个需要使用[] 数组包括起来，如是查询器这里不用填写。

$selector = new DBSelector('@pf_article');
$selector->field('id,title as name');
$selector->union('select id,name from @pf_category');

$sqlItem = $selector->buildSql();
print_r($sqlItem->format());

#输出结果：
/*
(select id,title as name from `@pf_article`) 
union 
( select id,name from `@pf_category`)
*/

$selector = new DBSelector('@pf_article');
$selector->field('id,title as name');

$selector2 = new DBSelector('@pf_column');
$selector2->field('id,name');

$selector3 = new DBSelector('@pf_category');
$selector3->field('id,name');

$selector->union($selector2);
$selector->union($selector3);

$sqlItem = $selector->buildSql();
print_r($sqlItem->format());
#输出结果
/*
( select id,title as name from `@pf_article` ) 
union ( select id,name from `@pf_column`) 
union ( select id,name from `@pf_category`)
*/

buildSql(bool $optimize = false):SqlFrame

生成SQL节点，其中

$optimize 是否要对sql 语句生成优化查询语句，对数据比较多且单表查询可以使用。
SqlFrame->sql 是生成的带有占位符的sql语句，不包含参数
SqlFrame->args 是占位符所需的参数。

可以使用

print_r($sqlItem->format());

查看完整的sql 语句。

buildCount(): SqlFrame

生成用于查询数量 SQL节点。

SqlFrame->sql 是生成的带有占位符的sql语句，不包含参数
SqlFrame->args 是占位符所需的参数。
生成的统计字段名为 mCount

可以使用

print_r($sqlItem->format());

查看完整的sql 语句。

$selector = new DBSelector('@pf_article');
$selector->field('id,title as name');
$selector2 = new DBSelector('@pf_column');
$selector2->field('id,name');
$selector3 = new DBSelector('@pf_category');
$selector3->field('id,name');
$selector->union($selector2);
$selector->union($selector3);

$sqlItem = $selector->buildCount();
print_r($sqlItem->format());
#输出结果是：
/*
select count(1) as mCount from 
(
( select id,title as name from `@pf_article` ) 
union ( select id,name from `@pf_column`) 
union ( select id,name from `@pf_category`)
) CTemp
*/

如果是单表：

$selector = new DBSelector('@pf_article');
$selector->field('id,title as name');
$selector->order('id desc');
$sqlItem = $selector->buildCount();
print_r($sqlItem->format());
#输出结果：
#select count(1) as mCount from `@pf_article`

getList(): array

获取所有数据集，二维数组

getRow(): ?array

获取1行数据集，如果没有找到返回 null

getCount(): int

获取查询条件可以查询到的数据行数。

pageList(): array

获取分页后的数据，默认以20行数据1页进行分页。

setPage(int $pageSize = 0, string $pageKey = 'page'): static

设置分页尺寸数，和分页从 $_REQUEST 中取值页码的键名。

$pageSize 分页尺寸，即多少条为1页，如果没有设置或者为0 默认是20
$pageKey 从$_REQUEST 中获得分页页码的参数名称。默认是 page

pageInfo(): array

获取分页信息数据
返回值是一个数组

[
    'keyName' => '分页的pageKey页码键名',
    'page' => '当前页码数',
    'pageCount' => '当前可分页数，最大页码数',
    'recordsCount' => '记录集数',
    'pageSize' => '分页尺寸，多个条记录为1页',
]

pageData(): array

返回分页数据 pageList() 和 pageInfo()
[
'list' =>pageList(),
'pageInfo' => pageInfo()
]

上一篇：DB (Mysql) 类

下一篇：Util 类