grantjm9992/pdo-helper

FluentPDO 是一个快速轻量级的 PHP 库,用于快速构建查询。它具有智能连接构建器,可以自动创建表连接。

1.0.8 2021-08-12 08:01 UTC

This package is auto-updated.

Last update: 2024-09-12 15:03:32 UTC


README

FluentPDO 是一个使用 PDO 的 PHP SQL 查询构建库。它是一个快速轻量级的库,具有智能连接构建器,可以自动为您创建表连接。

特点

  • 创建强大查询的简单接口
  • 支持任何与 PDO 兼容的数据库
  • 用很少的代码构建复杂的 SELECT、INSERT、UPDATE & DELETE 查询
  • 为魔法方法提供类型提示,在智能 IDE 中支持代码自动完成

版本

版本 2.x

FluentPDO 的稳定版本,正在积极维护。官方支持 PHP 7.3 到 PHP 8.0,但它也可以与 PHP 7 的早期版本一起使用。

版本 1.x

FluentPDO 的旧版发布。它不再受支持,也不会维护或更新。此版本与 PHP 5.4 到 7.1 兼容。

版本 3.x - alpha

此版本是从头开始完全重写的 Fluent。其主要优势是在查询构建中显著减少内存使用和大幅提高性能。它还添加了一些额外的限制,使查询更容易阅读和维护。文档也是一个非常常见的请求,版本 3 将在开发的同时进行全面文档化。详情和指标将在可用时发布。

参考

Sitepoint - FluentPDO 入门

安装

Composer

安装 FluentPDO 的首选方式是通过 composer

在您的 composer.json 文件中添加以下行

"require": {
	...
	"envms/fluentpdo": "^2.2.0"
}

使用 composer update 更新依赖项,您就完成了!

下载 Zip

如果您不想使用 composer,请下载最新版本,在您的库目录中创建 Envms/FluentPDO 目录,并将此存储库放入其中。最后,在您的应用程序顶部添加

require "[lib-dir]/Envms/FluentPDO/src/Query.php";

注意:您需要自动加载器才能在不更改其源代码的情况下使用 FluentPDO。

入门指南

创建一个新的 PDO 实例,并将该实例传递给 FluentPDO

$pdo = new PDO("mysql:dbname=fluentdb", "root");
$fluent = new \Envms\FluentPDO\Query($pdo);

然后,创建查询变得快速简单

$query = $fluent->from('comment')
             ->where('article.published_at > ?', $date)
             ->orderBy('published_at DESC')
             ->limit(5);

这将构建以下查询

SELECT comment.*
FROM comment
LEFT JOIN article ON article.id = comment.article_id
WHERE article.published_at > ?
ORDER BY article.published_at DESC
LIMIT 5

要从选择中获取数据,我们只需遍历返回的数组即可

foreach ($query as $row) {
    echo "$row[title]\n";
}

使用智能连接构建器

让我们从一个传统的连接开始,如下所示

$query = $fluent->from('article')
             ->leftJoin('user ON user.id = article.user_id')
             ->select('user.name');

这相当冗长,并不智能。如果您的表使用适当的主键和外键名称,您可以将上面的代码缩短为

$query = $fluent->from('article')
             ->leftJoin('user')
             ->select('user.name');

这更好,但还不是最佳选择。然而,通过 不写任何连接 将会更容易

$query = $fluent->from('article')
             ->select('user.name');

太棒了,FluentPDO 能够通过您在请求的列前附加外键表名来为您构建连接。

上面的所有三个代码片段都将创建完全相同的查询

SELECT article.*, user.name 
FROM article 
LEFT JOIN user ON user.id = article.user_id
关闭您的连接

最后,一旦完成其职责,就释放资源总是一个好主意

$fluent->close();

CRUD 查询示例

SELECT
$query = $fluent->from('article')->where('id', 1)->fetch();
$query = $fluent->from('user', 1)->fetch(); // shorter version if selecting one row by primary key
INSERT
$values = array('title' => 'article 1', 'content' => 'content 1');

$query = $fluent->insertInto('article')->values($values)->execute();
$query = $fluent->insertInto('article', $values)->execute(); // shorter version
UPDATE
$set = array('published_at' => new FluentLiteral('NOW()'));

$query = $fluent->update('article')->set($set)->where('id', 1)->execute();
$query = $fluent->update('article', $set, 1)->execute(); // shorter version if updating one row by primary key
DELETE
$query = $fluent->deleteFrom('article')->where('id', 1)->execute();
$query = $fluent->deleteFrom('article', 1)->execute(); // shorter version if deleting one row by primary key

注意:INSERT、UPDATE 和 DELETE 查询只有在您调用 ->execute() 之后才会运行

完整文档可以在 FluentPDO 主页 上找到

许可证

Apache 2.0GPL 2.0许可证下免费提供给商业和非商业使用。