README

这是一个轻量级、灵活的、框架无关的PHP查询构建器，也可以称为数据库抽象层。Pixie支持MySQL、SQLite和PostgreSQL，并使用统一的API处理查询清理、表前缀和其他许多事情。至少需要PHP 5.3。

它具有一些高级功能，例如：

查询事件
嵌套标准
子查询
嵌套查询
多个数据库连接。

其语法与Laravel的查询构建器相当相似。

示例

// Make sure you have Composer's autoload file included
require 'vendor/autoload.php';

// Create a connection, once only.
$config = array(
            'driver'    => 'mysql', // Db driver
            'host'      => 'localhost',
            'database'  => 'your-database',
            'username'  => 'root',
            'password'  => 'your-password',
            'charset'   => 'utf8', // Optional
            'collation' => 'utf8_unicode_ci', // Optional
            'prefix'    => 'cb_', // Table prefix, optional
            'options'   => array( // PDO constructor options, optional
                PDO::ATTR_TIMEOUT => 5,
                PDO::ATTR_EMULATE_PREPARES => false,
            ),
        );

new \Pixie\Connection('mysql', $config, 'QB');

简单查询

以下查询返回id = 3的行，如果没有行则返回null。

$row = QB::table('my_table')->find(3);

完整查询

$query = QB::table('my_table')->where('name', '=', 'Sana');

// Get result
$query->get();

查询事件

在以下代码之后，每次在users表上执行选择查询时，都会添加此where标准，因此禁止用户访问。

QB::registerEvent('before-select', 'users', function($qb)
{
    $qb->where('status', '!=', 'banned');
});

以下有很多高级选项，详细说明如下。想安装吗？让我们开始安装。

安装

Pixie使用Composer使事情变得简单。

学习如何使用Composer并将其添加到require部分（在你的composer.json中）

"usmanhalalit/pixie": "2.*@dev"

然后运行

composer update

在Packagist上。

完整使用API

连接
查询
选择
Where
Group By和Order By
Having
Limit和Offset
连接
- 多个连接标准
原始查询
- 原始表达式
插入
- 批量插入
- 使用ON DUPLICATE KEY语句插入
更新
删除
事务
获取构建的查询
子查询和嵌套查询
获取PDO实例
以指定类的对象获取结果
查询事件

连接

Pixie支持三个数据库驱动程序，MySQL、SQLite和PostgreSQL。您可以在创建新连接时指定驱动程序及其关联的配置。您还可以创建多个连接，但一次只能使用一个别名。;

// Make sure you have Composer's autoload file included
require 'vendor/autoload.php';

$config = array(
            'driver'    => 'mysql', // Db driver
            'host'      => 'localhost',
            'database'  => 'your-database',
            'username'  => 'root',
            'password'  => 'your-password',
            'charset'   => 'utf8', // Optional
            'collation' => 'utf8_unicode_ci', // Optional
            'prefix'    => 'cb_', // Table prefix, optional
        );

new \Pixie\Connection('mysql', $config, 'QB');

// Run query
$query = QB::table('my_table')->where('name', '=', 'Sana');

别名

创建连接时

new \Pixie\Connection('mysql', $config, 'MyAlias');

MyAlias是您想要使用的类别名的名称（例如MyAlias::table(...)），您可以使用任何名称（包括命名空间，如MyNamespace\\MyClass），或者如果您不需要别名，可以跳过它。别名让您能够轻松地在整个应用程序中访问QueryBuilder类。

如果不使用别名，您可以单独实例化QueryBuilder处理器，这对依赖注入和测试很有帮助。

$connection = new \Pixie\Connection('mysql', $config));
$qb = new \Pixie\QueryBuilder\QueryBuilderHandler($connection);

$query = $qb->table('my_table')->where('name', '=', 'Sana');

var_dump($query->get());

$connection在这里是可选的，如果没有提供，它将始终关联到第一个连接，但在您有多个数据库连接时，它可能很有用。

SQLite和PostgreSQL配置示例

new \Pixie\Connection('sqlite', array(
                'driver'   => 'sqlite',
			    'database' => 'your-file.sqlite',
			    'prefix'   => 'cb_',
		    ), 'QB');

new \Pixie\Connection('pgsql', array(
                    'driver'   => 'pgsql',
                    'host'     => 'localhost',
                    'database' => 'your-database',
                    'username' => 'postgres',
                    'password' => 'your-password',
                    'charset'  => 'utf8',
                    'prefix'   => 'cb_',
                    'schema'   => 'public',
                ), 'QB');

查询

您必须在每次查询之前使用 table() 方法，除了原始的 query() 方法。要从多个表中选择，只需传递一个数组。

QB::table(array('mytable1', 'mytable2'));

轻松获取

以下查询返回 id = 3 的（第一）行，如果没有行则返回 null。

$row = QB::table('my_table')->find(3);

像这样访问您的行，echo $row->name。如果您的字段名不是 id，则将字段名作为第二个参数传递 QB::table('my_table')->find(3, 'person_id');。

以下查询返回 name = 'Sana' 的所有行，如果没有行则返回 null。

$result = QB::table('my_table')->findAll('name', 'Sana');

选择

$query = QB::table('my_table')->select('*');

多个选择

->select(array('mytable.myfield1', 'mytable.myfield2', 'another_table.myfield3'));

多次使用 select 方法 select('a')->select('b') 也会选择 a 和 b。如果您想在 PHP 的 if 中进行条件选择，这可能会很有用。

选择不同

->selectDistinct(array('mytable.myfield1', 'mytable.myfield2'));

获取所有

返回一个数组。

$query = QB::table('my_table')->where('name', '=', 'Sana');
$result = $query->get();

您可以通过以下方式遍历它

foreach ($result as $row) {
    echo $row->name;
}

获取第一行

$query = QB::table('my_table')->where('name', '=', 'Sana');
$row = $query->first();

返回第一行，或如果没有记录则返回 null。使用此方法，您还可以确保记录是否存在。像这样访问它们 echo $row->name。

获取行数

$query = QB::table('my_table')->where('name', '=', 'Sana');
$query->count();

Where

基本语法是 (字段名，操作符，值)，如果您提供两个参数，则假定操作符为 =。因此，where('name', 'usman') 和 where('name', '=', 'usman') 是相同的。

QB::table('my_table')
    ->where('name', '=', 'usman')
    ->whereNot('age', '>', 25)
    ->orWhere('type', '=', 'admin')
    ->orWhereNot('description', 'LIKE', '%query%')
    ;

Where In

QB::table('my_table')
    ->whereIn('name', array('usman', 'sana'))
    ->orWhereIn('name', array('heera', 'dalim'))
    ;

QB::table('my_table')
    ->whereNotIn('name', array('heera', 'dalim'))
    ->orWhereNotIn('name', array('usman', 'sana'))
    ;

Where Between

QB::table('my_table')
    ->whereBetween('id', 10, 100)
    ->orWhereBetween('status', 5, 8);

Where Null

QB::table('my_table')
    ->whereNull('modified')
    ->orWhereNull('field2')
    ->whereNotNull('field3')
    ->orWhereNotNull('field4');

分组Where

有时查询会变得复杂，需要分组标准，例如 WHERE age = 10 and (name like '%usman%' or description LIKE '%usman%')。

Pixie 允许您这样做，您可以根据需要嵌套任意数量的闭包，如下所示。

QB::table('my_table')
            ->where('my_table.age', 10)
            ->where(function($q)
                {
                    $q->where('name', 'LIKE', '%usman%');
                    // You can provide a closure on these wheres too, to nest further.
                    $q->orWhere('description', 'LIKE', '%usman%');
                });

Group By和Order By

$query = QB::table('my_table')->groupBy('age')->orderBy('created_at', 'ASC');

多重分组

->groupBy(array('mytable.myfield1', 'mytable.myfield2', 'another_table.myfield3'));

->orderBy(array('mytable.myfield1', 'mytable.myfield2', 'another_table.myfield3'));

多次使用 groupBy() 或 orderBy() 方法 groupBy('a')->groupBy('b') 也会按顺序分组 a 和 b。如果您想在 PHP 的 if 中进行条件分组，这可能会很有用。同样适用于 orderBy()。

Having

->having('total_count', '>', 2)
->orHaving('type', '=', 'admin');

Limit和Offset

->limit(30);

->offset(10);

连接

QB::table('my_table')
    ->join('another_table', 'another_table.person_id', '=', 'my_table.id')

可用方法

join() 或 innerJoin
leftJoin()
rightJoin()

如果您需要 FULL OUTER 连接或任何其他连接，只需将其作为 join 方法的第五个参数传递。

->join('another_table', 'another_table.person_id', '=', 'my_table.id', 'FULL OUTER')

多个连接标准

如果您需要多个标准来连接一个表，则将闭包作为第二个参数传递。

->join('another_table', function($table)
    {
        $table->on('another_table.person_id', '=', 'my_table.id');
        $table->on('another_table.person_id2', '=', 'my_table.id2');
        $table->orOn('another_table.age', '>', QB::raw(1));
    })

原始查询

如果需要，您始终可以使用原始查询

$query = QB::query('select * from cb_my_table where age = 12');

var_dump($query->get());

您也可以传递您的绑定

QB::query('select * from cb_my_table where age = ? and name = ?', array(10, 'usman'));

原始表达式

当您使用 raw() 方法包装表达式时，Pixie 不会尝试对其进行清理。

QB::table('my_table')
            ->select(QB::raw('count(cb_my_table.id) as tot'))
            ->where('value', '=', 'Ifrah')
            ->where(QB::raw('DATE(?)', 'now'))

注意：通过 query() 方法运行的查询直到您通过绑定传递所有值之前都不会进行清理。通过 raw() 方法运行的查询也不会进行清理，您必须自己进行清理。当然，这些也不会添加表前缀，但您可以使用 addTablePrefix() 方法。

插入

$data = array(
    'name' => 'Sana',
    'description' => 'Blah'
);
$insertId = QB::table('my_table')->insert($data);

insert() 方法返回插入 ID。

批量插入

$data = array(
    array(
        'name'        => 'Sana',
        'description' => 'Blah'
    ),
    array(
        'name'        => 'Usman',
        'description' => 'Blah'
    ),
);
$insertIds = QB::table('my_table')->insert($data);

在批量插入的情况下，它将返回一个插入 ID 数组。

使用ON DUPLICATE KEY语句插入

$data = array(
    'name'    => 'Sana',
    'counter' => 1
);
$dataUpdate = array(
    'name'    => 'Sana',
    'counter' => 2
);
$insertId = QB::table('my_table')->onDuplicateKeyUpdate($dataUpdate)->insert($data);

更新

$data = array(
    'name'        => 'Sana',
    'description' => 'Blah'
);

QB::table('my_table')->where('id', 5)->update($data);

将名称字段更新为 Sana，并将描述字段更新为 Blah，其中 id = 5。

删除

QB::table('my_table')->where('id', '>', 5)->delete();

删除所有 id 大于 5 的行。

事务

Pixie 具有运行数据库 "事务" 的能力，在事务中，所有数据库更改在提交之前都不会保存。这样，如果出现问题或与您预期的情况不同，则不会保存数据库更改，也不会进行任何更改。

这是一个基本事务的例子

QB::transaction(function ($qb) {
    $qb->table('my_table')->insert(array(
        'name' => 'Test',
        'url' => 'example.com'
    ));

    $qb->table('my_table')->insert(array(
        'name' => 'Test2',
        'url' => 'example.com'
    ));
});

如果这会导致任何错误（例如重复名称或其他此类错误），则数据库中不会显示任何数据集。如果没有错误，更改将成功保存。

如果您希望手动提交或回滚更改，可以使用相应的 commit() 和 rollback() 方法。

QB::transaction(function (qb) {
    $qb->table('my_table')->insert(array(/* data... */));

    $qb->commit(); // to commit the changes (data would be saved)
    $qb->rollback(); // to rollback the changes (data would be rejected)
});

获取构建的查询

有时您可能需要获取查询字符串，这是可能的。

$query = QB::table('my_table')->where('id', '=', 3);
$queryObj = $query->getQuery();

getQuery() 将返回一个查询对象，您可以从其中获取 SQL、绑定或原始 SQL。

$queryObj->getSql();
// Returns: SELECT * FROM my_table where `id` = ?

$queryObj->getBindings();
// Returns: array(3)

$queryObj->getRawSql();
// Returns: SELECT * FROM my_table where `id` = 3

子查询和嵌套查询

很少，但您可能需要进行子查询或嵌套查询。Pixie 足够强大，可以为您执行此操作。您可以创建不同的查询对象，并使用 QB::subQuery() 方法。

$subQuery = QB::table('person_details')->select('details')->where('person_id', '=', 3);


$query = QB::table('my_table')
            ->select('my_table.*')
            ->select(QB::subQuery($subQuery, 'table_alias1'));

$nestedQuery = QB::table(QB::subQuery($query, 'table_alias2'))->select('*');
$nestedQuery->get();

这将产生如下查询

SELECT * FROM (SELECT `cb_my_table`.*, (SELECT `details` FROM `cb_person_details` WHERE `person_id` = 3) as table_alias1 FROM `cb_my_table`) as table_alias2

注意： Pixie 对于子查询和嵌套查询不使用绑定。它使用 PDO 的 quote() 方法引用值。

获取PDO实例

如果您需要获取 PDO 实例，可以这样做。

QB::pdo();

以指定类的对象获取结果

只需调用查询方法的 asObject。

QB::table('my_table')->asObject('SomeClass', array('ctor', 'args'))->first();

此外，您还可以通过调用 setFetchMode 方法来微调获取模式。

QB::table('my_table')->setFetchMode(PDO::FETCH_COLUMN|PDO::FETCH_UNIQUE)->get();

查询事件

Pixie 提供了强大的查询事件，以增强您的应用程序。这些事件类似于数据库触发器，您可以在事件发生时执行某些操作，例如，您可以挂钩表的 after-delete 事件，并从另一张表中删除相关数据。

可用事件

before-select
after-select
before-insert
after-insert
before-update
after-update
before-delete
after-delete

注册事件

QB::registerEvent('before-select', 'users', function($qb)
{
    $qb->where('status', '!=', 'banned');
});

现在每次在 users 表上发生选择查询时，都会添加此 where 条件，因此被禁止的用户无法访问。

语法是 registerEvent('事件类型', '表名', 闭包中的操作)。

如果您希望事件在 任何表被查询时 执行，请将 ':any' 作为表名提供。

其他示例

将数据插入 my_table 后，详细信息将插入到另一张表中

QB::registerEvent('after-insert', 'my_table', function($queryBuilder, $insertId)
{
    $data = array('person_id' => $insertId, 'details' => 'Meh', 'age' => 5);
    $queryBuilder->table('person_details')->insert($data);
});

当数据被插入到 person_details 表中时，设置时间戳字段 created_at，这样我们就不必在所有地方指定它。

QB::registerEvent('after-insert', 'person_details', function($queryBuilder, $insertId)
{
    $queryBuilder->table('person_details')->where('id', $insertId)->update(array('created_at' => date('Y-m-d H:i:s')));
});

从 my_table 删除后删除关系

QB::registerEvent('after-delete', 'my_table', function($queryBuilder, $queryObject)
{
    $bindings = $queryObject->getBindings();
    $queryBuilder->table('person_details')->where('person_id', $binding[0])->delete();
});

Pixie 将当前查询构建器的实例作为闭包的第一个参数传递，因此您可以使用此对象构建查询，您可以像通常的查询构建器 (QB) 一样执行任何操作。

如果从 before-* 查询处理程序返回的不是 null，则该值将是执行结果，并且实际上不会查询数据库（因此，相应的 after-* 处理程序也不会被调用）。

仅在 after-* 事件中您会得到三个参数：第一个 是查询构建器，第三个 是执行时间作为浮点数，第二个 则不同。

在 after-select 中，您会得到从 select 获得的 results。
在 after-insert 中，您会得到插入 id（或在批量插入的情况下是 id 数组）。
在 after-delete 中，您会得到查询对象（与您从 getQuery() 获得的对象相同），从中您可以获取 SQL 和绑定。
在 after-update 中，您会得到与 after-delete 相同的查询对象。

移除事件

QB::removeEvent('event-name', 'table-name');

一些用例

以下是一些查询事件可能非常有帮助的情况

限制被禁止的用户。
仅获取 deleted = 0 记录。
实现所有查询的缓存。
每次条目后触发用户通知。
删除查询后删除关系数据。
插入查询后插入关系数据。
记录每次更新查询后的修改。
在每次条目后添加/编辑 created_at 和 updated_at 数据。

注意

查询事件按连接设置，因此多个数据库连接不会引起任何问题，创建新的查询构建器实例会保留您的事件。
查询事件是递归的，例如，在向 table_a 插入后，您的事件会插入到 table_b 中，现在您可以在 table_b 上注册另一个事件，该事件会插入到 table_c 中。
当然，查询事件不与原始查询一起工作。

如果您发现任何错别字，请编辑并发送 pull request。

acburdine / pixie-backports

维护者

详细信息