Doctrine ORM＠Symfony¶
はじめに¶
本サイトにつきまして、以下をご認識のほど宜しくお願いいたします。
01. Doctrine ORMとは¶
Symfonyに組み込まれているORM。
Data Mapperパターンで実装されている。
02. DoctrineによるCRUD¶
SQLの定義¶
▼ createQueryBuilderメソッド¶
CRUD処理に必要なSQLを保持し、トランザクションによってSQLを実行する。
＊実装例＊
<?php
// QueryBuilderインスタンスを作成。
$queryBuilder = $this->createQueryBuilder();
読み出し¶
▼ selectメソッド¶
QueryBuilderクラスにおけるselectメソッドに、値を設定する。
＊実装例＊
<?php
$queryBuilder
->select("id", "name")
->from("mst_users");
書き込み¶
▼ insertメソッド¶
QueryBuilderクラスにおけるinsertメソッドに、値を設定する。
＊実装例＊
<?php
$queryBuilder
->insert("mst_users")
▼ updateメソッド¶
QueryBuilderクラスにおけるupdateメソッドに、値を設定する。
＊実装例＊
<?php
$queryBuilder
->update("mst_users");
▼ deleteメソッド¶
QueryBuilderクラスにおけるdeleteメソッドに、値を設定する。
＊実装例＊
<?php
$queryBuilder
->delete("mst_users");
実行¶
▼ getConnectionメソッド、executeQueryメソッド、fetchAllメソッド¶
DBへの接続し、SQLの実行する。
DB接続に関わるgetConnectionメソッドを開始点として、返り値から繰り返しメソッドを取得し、fetchAllメソッドで、テーブルのクエリ名をキーとした連想配列が返される。
＊実装例＊
<?php
// DBに接続。
$queryBuilder->getConnection()
// SQLを実行し、レコードを読み出す。
->executeQuery($queryBuilder->getSQL(),
$queryBuilder->getParameters()
)->fetchAll();
読み出し系の操作¶
▼ プレースホルダー¶
プリペアードステートメントのSQL中にパラメーターを設定し、値をパラメーターに渡した上で、SQLとして発行する。
処理速度が速い。
また、パラメーターに誤ってSQLが渡されても、これを実行できなくなるため、SQLインジェクションの対策にもなる。
＊実装例＊
<?php
use Doctrine\DBAL\Connection;
class DogToyQuery
{
// READ処理のSQLを定義するメソッド。
public function read(Value $toyType): Array
{
// QueryBuilderインスタンスを作成。
$queryBuilder = $this->createQueryBuilder();
// プリペアードステートメントの定義
$queryBuilder->select([
"dog_toy.type AS dog_toy_type",
"dog_toy.name AS dog_toy_name",
"dog_toy.number AS number",
"dog_toy.price AS dog_toy_price",
"dog_toy.color_value AS color_value"
])
// FROMを設定する。
->from("mst_dog_toy", "dog_toy")
// WHEREを設定する。この時、値はプレースホルダーとしておく。
->where("dog_toy.type = :type")
// プレースホルダーに値を設定する。ここでは、引数で渡す『$toyType』とする。
->setParameter("type", $toyType);
// DBに接続。
return $queryBuilder->getConnection()
// SQLを実行し、レコードを読み出す。
->executeQuery($queryBuilder->getSQL(),
$queryBuilder->getParameters()
)->fetchAll();
}
}
▼ データのキャッシュ¶
読み出し系で取得したデータをキャッシュできる。
<?php
use Doctrine\Common\Cache\FilesystemCache;
use Doctrine\DBAL\Cache\QueryCacheProfile;
class Foo
{
public function find()
{
// QueryBuilderインスタンスを作成。
$queryBuilder = $this->createQueryBuilder();
// 何らかのSQLを定義
$query = $queryBuilder->select()->from()
// キャッシュがある場合、ArrayStatementオブジェクトを格納
// キャッシュがない場合、ResultCacheStatementを格納
$statement = $this->connection->executeQuery(
$query->getSQL(),
$query->getParameters(),
$queryParameterTypes(),
new QueryCacheProfile()
);
$result = $statement->fetchAll();
$statement->closeCursor();
return $result;
}
}
書き込み系の操作¶
▼ トランザクション開始、コミット、ロールバック¶
RDBの処理用語に相当するbeginTransactionメソッド、commitメソッド、rollBackメソッドを使用して、RDBを操作する。
＊実装例＊
<?php
$conn = new Doctrine\DBAL\Connection
// トランザクションを開始する
$conn->beginTransaction();
try{
// コミットを実行する
$conn->commit();
} catch (\Exception $e) {
// ロールバックを実行する
$conn->rollBack();
throw $e;
}