README

PHP 5.3 で動くクエリービルダー

要件

PHP5.3以上

サポート

MySQL

インストール

Composer経由でインストールします

{
    "require": "niikunihiro/poulsen": "dev-master"
}

使い方

src/Config/database.php でアクセス情報を設定する

return array(
    'default' => 'mysql',
    'connections' => array(
        'mysql' => array(
            'driver'    => 'mysql',
            'host'      => 'localhost',
            'database'  => 'database',
            'username'  => 'username',
            'password'  => 'password',
            'charset'   => 'utf8',
            'collation' => 'utf8_unicode_ci',
            'prefix'    => '',
            'strict'    => false,
        ),
    ),
);

基本

Builderクラスのインスタンスを生成し、table()メソッドで対象のテーブルを指定します。

require_once __DIR__ .'/vendor/autoload.php';
use Poulsen\Query\Builder;

$DB = new Builder;
$query = $DB->table('users');

または、インスタンスの生成時にテーブルを指定する事も出来ます

$query = new Builder('users');

テーブルを指定したBuilderクラスのインスタンスを取得したら、続けてデータの取得、挿入、更新、削除用のメソッドを指定して操作を行います。 Builderクラスのメソッドは直感的に扱えるようにチェーンメソッドで呼び出せるようになっています。

データの取得

データを配列で取得

配列の各要素はオブジェクトになっています。

$users = $DB->table('users')->get();

データを一件取得

一件だけ取得したデータはオブジェクトになっています。

$user = $DB->table('users')->first();

カラムを指定して、データを取得

$users = $DB->table('users')->select('id', 'name', 'email AS mail_address')->first();

条件を指定する

$result = $DB->table('users')->where('name', '=', 'niikunihiro')->get();

LIKE条件を指定する

$users = $DB->table('users')->where('name', 'LIKE', 'nii%')->get();

複数条件を指定する

$users = $DB->table('users')
    ->where('name', 'LIKE', 'nii%')
    ->orWhere('name', '<>', 'poulsen')
    ->get();

もうちょっと複雑な条件を指定する

where()メソッドの引数に無名関数を渡すと括弧で囲んだ条件を作成する事が出来ます

$user = $DB->table('users')
    ->where('name', '=', 'poulsen')
    ->orWhere(function($query)
    {
        $query->whereIn('role_id', array(1, 2, 3));
        $query->where('updated_at', '>', '2015-05-08 11:00:00');
    })
    ->get();

上の例は次のSQLをビルドします

SELECT * FROM users 
WHERE 1 AND name = 'poulsen' 
OR (role_id IN(1, 2, 3) AND updated_at > '2015-05-08 11:00:00')

テーブル結合

テーブル結合を行う場合はjoin()メソッドを使用します。
join()メソッドは第1引数に結合するテーブル名を指定します。第2引数から第4引数まではON句の条件を指定します。

$comments = $DB->table('articles')
            ->select('articles.title', 'comments.body AS comment')
            ->join('comments', 'article_id', '=', 'id')
            ->get();

外部結合を使いたい場合はjoin()メソッドの第5引数にLEFTまたはRIGHTを指定してください。

$comments = $DB->table('articles')
            ->select('articles.title', 'comments.body AS comment')
            ->join('comments', 'article_id', '=', 'id', 'RIGHT')
            ->get();

レコード挿入

values()メソッドでデータを設定し、insert()メソッドでレコードを挿入します。
insert()メソッドは挿入したレコードのIDを返します

$now = with(new DateTime)->format('Y-m-d H:i:s');
$id = $DB->table('users')
         ->values('username', 'poulsen')
         ->values('email', 'poulsen@example.com')
         ->values('password', '$2y$10$/L1ScTA7H7KTfS0Josftk.qPeAygzOZOB1GClEkTlMzmmuFw7/Yxa')
         ->values('created_at', $now)
         ->values('updated_at', $now)
         ->insert();

with()関数はコンストラクターメソッドチェーンのためのショートカットに利用できます。

レコード更新

set()メソッドでデータを設定し、update()メソッドでレコードを更新します。

$now = with(new DateTime)->format('Y-m-d H:i:s');
$DB->table('users')
         ->set('rank', 3)
         ->set('updated_at', $now)
         ->update();

条件を指定する場合は、where()メソッド等を利用します。

$DB->table('users')
         ->set('rank', 1)
         ->set('updated_at', $now)
         ->where('id', '=', 32)
         ->update();

レコード削除

レコードを削除する場合は、delete()メソッドで削除します。
※where()メソッド等で条件を指定しない場合は、削除を行わずにfalseを返します。

$DB->table('users')
         ->where('id', '=', 32)
         ->delete();

クエリーログ

クエリーログを確認するために、ChromePhpを内部で使用しています。

ログの出力を停止する場合は、Poulsen\Query\Builderクラスのオブジェクト定数ENVIRONの値をproductionに設定します。

namespace Poulsen\Query;

class Builder {

    /** 環境 'production'の場合はログを出力しない */
    const ENVIRON = 'develop';

niikunihiro / poulsen

Maintainers

Details