PDOクラスのprepareメソッドについて。

Question

いつもお世話になっております。
PHP5.2.5

１｜$conn = new PDO($dsn,～略～); 　　//データベース接続
２｜$sql = "略"; 　　　　　　　　　　　　//SQL文
３｜$stmt = $conn->prepare($sql); 　　// PDOStatementオブジェクトを返す
４｜$stmt->bindParam(～略～); 　　　　//プレースホルダに変数をバインド
５｜$stmt->execute(); 　　　　　　　　//クエリ実行

という、よくある流れにおいて、
４行目のbindParamメソッドは、PDOクラスのメソッドではなく、
PDOStatementクラスのメソッドだと思うのですが、
これを、$stmt-> で呼び出せているのが、どうしてなのかがよく分からずにいます。

３行目で、PDOクラスのprepareメソッドを使うことで、
PDOStatementオブジェクトが返されるため、
その返り値を受け取った「$stmt」によって、
「$stmt->bindParam」できているという感じでしょうか？

★まず、この私の考え方について、合っているか間違っているか、
お聞きしたいと思います。（質問１）

//===================================================

恐らく、上記の考え方は「合っている」のだと思うのですが、
その上で、さらに質問をさせて頂くと、

ではなぜ、PDOStatementクラスを使う時に、
new PDOStatement;
というようにしないのでしょうね？

PDOクラスの１メソッドであるprepareメソッドを使うようにして、
PDOStatementクラスをインスタンス化しているのはなぜなのでしょう？
（prepareメソッドはどういうコードになっているのでしょう？その中で、new PDOStatement という記述があるのでしょうね？）

PDOのこのような仕様の背景には、どういう意図があるのか、
どなたか何か思い当たることなどありましたらご助言下さい。
（質問２）

hogehoge78 · Accepted Answer

■prepareメソッドが自分で作成したprivate領域にある情報等々、PDOのメンバ変数がpublicかprotectedなのかprivateなのかを知るすべ
知るすべは無いです。多分。

どちらにしても、マニュアル上、特に記載が無いので、全部privateかprotectedになっているのではないかと思います。

とりあえず、想像される内容に関しては、エラー処理や細かい設定云々全て考えないこととして、

public function prepare($sql, $options){

return new PDOStatment($this->db, $sql, $option);

}

こんな感じなんだと思います。ここに出てきた「$this->db」に関しては、mysql_connect/sqlite_openなどが返す、リソースと同様なものと思ってください。
このメンバ変数は、PDOがnewされ、DBに接続を行ったときに取得されると想定されます。
そしてこのメンバ変数はprivateかprotectedか、とにかく外部からの参照が出来ないものです。
外部から参照が出来ないわけですが、prepareメソッドは内部で持っているメソッドなので、参照することが出来ます。
ゆえに、prepareメソッドが、PDOStatmentクラスのコンストラクタに引数として与えることが出来ます。

ここら辺は、一度、適当なクラス「A」と「B」でも作って、AクラスのメソッドがBクラスのコンストラクタを返すようなサンプルプログラムでも作ってみて、確認してみてください。


■exec/query/prepareメソッドに関して
どのメソッドも、恐らくPDOStatmentクラスを使ってると思います。
単純にexec/queryは、プリペアドステートメントを利用しないものですので、メソッド内部で、PDOStatmentのコンストラクタを作って、executeメソッドを叩くところまで行って、
execは実行結果影響のあった行数を返し、queryはexecute実行済みのPDOStatmentを返します。

想定される使い方としては、execメソッドの場合は、DELETE文やINSERT文、UPDATE文など、SQL発行後、fetchなどして結果を得る必要が無い文の場合に利用する。
queryメソッドの場合は、SELECT文などで、SQL発行後に、fetchなどして結果を得たい場合に利用する。

そんなところだと思います。

hogehoge78 · Answer

＞これら２つは、
＞「メソッド内部で、PDOStatmentのコンストラクタを作って、executeメソッドを叩くところまで行く」
＞ここまでの処理内容はほとんど同じ、ということでしょうか。
そうですね。ただ実際にソースを確認したわけではないので、「恐らくそうでしょう」というところになります。
ただ、先の回答で伝えたとおり、PDOStatmentクラスがSQLの実行及び操作を担当していることから、exec/queryでも同様にPDOStatmentクラスを呼び出して実行するであろうな、と想像は付きます。

＞execとqueryについて。
＞クエリ実行後に、その後の処理のために、
＞クエリ結果を受け取る必要があるかないかで、
＞execとqueryは使い分けられる、ということですよね。
そういうことですね。

hogehoge78 · Answer

＞質問１と質問２なので、そちらに主眼を置いて頂けると嬉しいです。
了解しました。

質問１に関しては最初のnaktakさんの回答で終了してますね。

質問２については、なぜ、「new PDOStatment」としないのか、ということでよいのでしょうか？
naktakさんの二番目の回答のように、何らかの情報「$stmt_prepare」を受け取って、
new PDOStatment($stmt_prepare);
とするとして、では「$stmt_prepare」に与えられる「何らかの情報」ってなんでしょうね、と考えたときに、少なくとも
・mysql_connect/sqlite_openなどで渡されるようなDB接続リソース相当のもの
・プリペアドステートメントでつかうSQL文
・prepareメソッドの第二引数に入れたオプション
が$stmt_prepareの中に必要です。
で、これらの情報を外だしすることに意味がなさそうですが、いかがでしょう。むしろ変数として外だししたのであれば、コーディングミスなどでその変数に何らかの値を上書きして、予期せぬエラーを起こしかねません。
それだけでもprepareメソッドが自分で作成したprivate領域にある情報等々をPDOStatmentに勝手に代入して、インスタンス化したものを戻してくれるのであれば願ったりかなったりではないかなぁと思いますがいかがでしょうか。


ちなみに、プリペアドステートメントを利用しなくても良い、ということであれば、
<?php
$conn = new PDO($dsn,～略～); //データベース接続
$sql = "略"; //SQL文
$stmt = $conn->query($sql); // すでにexecuteメソッドが叩かれた状態のPDOStatementオブジェクトを返す。

$data = $stmt->fetch();
?>
こんな書き方も出来ますが、これではだめですか？

prepareはあくまでプリペアドステートメントを使うための準備を行うメソッドです。
それに対して、PDOStatmentは、与えられた命令文に対して操作を行うクラスです。
命令文とは、SQL文と、今までのDB関連関数群には無かった概念であるプリペアドステートメント（コンパイルされたSQL文）の二種類あります。
なので、結果セットを操作するメソッド（fetchなど）と、命令文を実行するメソッドのほかに、プリペアドステートメントに渡す変数をセットするメソッド（bindParamなど）を持つ必要があります。

それぞれの役割分担として、かなり綺麗にクラスが分かれているように思えますが、それでもやっぱりPDOに全て集約したほうが判りやすいと思われますか？

hogehoge78 · Answer

ちょっと横からのちゃちゃいれのようになってしまいますが

下記の質問の補足/お礼を読んで尚、
「結局、【B】での返り値は、何なのさ」
と思いました。
返り値が何なのかが確定しないと、次回の回答もしづらいと思います。

＞ご提示頂いた、
＞$res1 = $conn->prepare($sql1); 
＞この式で返されるリソースとは一体…。
コレは多分、PDOStatmentクラスが無くても、prepareに渡されたSQLやその関連情報をPDOクラスに格納するといった場合、
$conn->prepare($sql1);
$conn->prepare($sql2);
$conn->prepare($sql3);
などと連続してSQLを叩かれた場合に、PDOクラス内部で、情報として、それらを区別して全部持ってる必要があるので、それらに何らかの番号を振る必要があるわけですよね。
例えば内部的には、
$sql = array(0=>$sql1, 1=>$sql2, 3=>$sql3)
とかといったように。
リソースとはその番号のことをさしているのではないかなと思います。
そうでなければ、
$conn->bind();
と叩いたときに、いったいどのSQLに対してそのメソッドが発行されたのか分からなくなってしまいますよね。

hrm_mmm · Answer

２つにする理由は、対象の絞り込みと役割の違いというところかな。
＞PDOクラスの中に必要なメソッドを与える
すべてを一つのクラスに入れる方法ですと、データベースごとの関数mysql_fetch などのように、どのqueryからのリソースを使うのかを、毎回引数で指定しないとなりません。
クラス化の利点があんまり無くなってしまいます。
別クラスにすることで、queryごとにそれぞれ別のインスタンスに保持して、基本となること（リソースがどれか）は、インスタンスが知っているから、引数にそれを指定しなくても、そこから何を取り出したいのかによって、メソッドを使うだけとなります。
とはいえ、もともと、接続用リソースと、query結果用リソースがあって、それぞれにクラスを作ったともいえますので、開発の基本理由までは解りませんが。

オブジェクト指向の考え方の一つに、クラスの粒度というのがあります。
今回ご指摘のように、PDOクラス一つに全部閉じこめるのか、それとも、query結果だけを操作できるクラスを作成して、query結果にしか作用しないメソッドをそこに集めて、PDOクラスの方は、接続やエラー処理に専念できるようにするのか、といったことですが、おおむね、クラス分化する方がいいようです。

ご呈示のソースA、Bでは表示上同じですが、
$stmt1 = $conn->prepare($sql1);
$stmt1->execute();　//PDOオブジェクト1のexecuteメソッドの返り値
Bの場合、$stmt1 には、何が返っているのでしょう？$connを複製して、prepareした接続情報をもつもの？

$connが異なる状態で複製が存在すると、上記の作業を交互にやった場合
$stmt1 = $conn->prepare($sql1);
$stmt2 = $conn->prepare($sql1);
$stmt1->execute();
$stmt2->execute();

$stmt1->execute 時点で、$stmt1 が持っている接続情報は、最新ではなくなり、発行できないかもしれません。よって、fetchまで全部やってからでないと次のsql文をprepareできない状況が容易に発生します。
それよりは、prepareの返値は成功したか否かとリソース識別情報だけとして、$connがずっとprepare後の基本情報を保持していればいいわけですよね？
→　クラスを一つにするには、以下のようになります。
// 前回のaテーブルデータをbテーブルに挿入の場合
$res1 = $conn->prepare($sql1);// リソース識別子を返す、不成功時はfalse
$res2 = $conn->prepare($sql2);
if( $res1 !== false and $res2 !== false ){
  $conn->bind(,, $res1);// リソース識別子ごとにbind
  $conn->execute($res1);
 while( $row= $conn->fetch($res1) ){
  $conn->bind(,, $res2);
  $conn->execute($res2);
//  $conn->fetch($res2);
 }
}

結局、クラスメンテナンス上も、一つにするとバグ探しは大変だし、利用する側からも、クラス分けされていた方が使い勝手がよいと、私は思います。
オブジェクト指向の目的の一つにメンテナンスを楽にするというのもあるので。

hrm_mmm · Answer

SQLiteのオブジェクト指向言語型スタイルも同じ作りなので、オブジェクト指向についての理解を深めるのがよいかと思いますが、
私も、実際のphp本体のソースを見たわけではありませんが、いろいろ自分でクラス作成していくとこの動作にするのが結構有用なのが推測できます。

１．PDOStatementを個別newして、PDOオブジェクトを引数で渡すとすると、
PDOStatementオブジェクトから、引数で渡されたPDOオブジェクトのデータを見るには、それらのデータがpublicになっているまたは、publicなgetterメソッドが必要ですが、
PDOオブジェクトのメソッド内であれば、PDOオブジェクトのprivateデータ(データベース接続idや、場合によってはパスワードなども？)を外に開示することなくPDOStatementオブジェクトに引き渡すことが出来ます。
php5でクラスのプロパティやメソッドにpublicとprivateの区別ができるようになったので、こういった作りが可能になったとも云えます。

２．また、PDOクラスとPDOStatementとを分けているのは、PDOオブジェクトは一つのままでも、異なるsql文での結果を、個別に保持できるからです。
ex.　以下ご呈示のソースにちょっと味付け
１｜$conn = new PDO($dsn,～略～);　　//データベース接続
　｜$conn->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);　// errorの時例外を投げるように設定する
２｜$sql1 = "select * from a where 略"; 　//SQL文
３｜$stmt = $conn->prepare($sql1); 　// PDOStatementオブジェクトを返す
４｜$stmt->bindParam(～略～);　　　　//プレースホルダに変数をバインド
５｜$stmt->execute();　　　　　　　　//クエリ実行, select文の結果行を保持
６｜//  database が対応していれば、ここでtransaction 開始
７｜try{
８｜　$sql2 = "insert into b  略"; 　　//SQL文 
９｜　$stmt2 = $conn->prepare($sql2);　//$stmtとは別の PDOStatementオブジェクトを返す
10｜　while ($row = $stmt->fetch(PDO::FETCH_ASSOC) ){　// $sql1の各行処理
11｜　　$stmt2->bindParam(～略～);　　//プレースホルダにsql1から得られたデータをバインド
12｜　　$stmt2->execute();　　　　　　//$sql2のクエリ実行
13｜　}
14｜} catch (PDOException $e) {
15｜//  transaction に対応しているデータベースなら rollback
16｜}

先に全部fetchしないと、次のsql文を発行できないデータベースもあるかもしれませんが、MySQLやSQLiteでは、上記の様なことは問題なく出来ています。execute()の時点でPDOStatementオブジェクト内に、データをストックしているような感じです。

naktak · Answer

＃１です。
私もPDOはさっぱり利用してきませんでしたし、なぜそういう仕様になったかまでは
説明することは出来ません。
最近はめっきりPHPも触らなくなってきたので・・・。

> １｜//（１）：「指定されたクエリをプリペアドステートメントとして準備を行う」
> ２｜$stmt_prepare = $conn->prepare($sql);
> ３｜
> ４｜//（２）：（１）を受けて、「PDOStatementオブジェクトを生成し、戻り値として返す」
> ５｜$stmt = new PDOStatement($stmt_prepare);

確かにこのような方法でも可能のように思われますが、
この方法では、$stmt_prepareには何が設定されるのでしょう？
この方法では、$stmt_prepareには最低限、どういったデータベースに
接続したのかという情報やらPDOStatementで利用可能な『準備された情報』が
必要になってしまい、新たなオブジェクトを要すと思いますし、
『準備された情報』がせっかく準備されたのに、あとで利用者に
よっていじられる可能性を秘めていると思います。

PDOのやり方ではそれを必要としません。
PDOStatementからクエリの実行などが行えることから、PDOStatement
には少なからずデータベースの接続情報などが存在していると思います。
PDOオブジェクト上で準備を整えるのではなく、準備が整ったPDOStatement
オブジェクトを$stmtが得ている感じです。

たぶん。
何故そういう仕様なのかと聞かれると気にしたことないので分かりませんが、
決まったSQLは決まったデータベースで動作するはずだという考えの
下に出来上がった仕様なのでは？

> PDOStatementクラスというものを利用する場合は、
> 「常に、」PDOクラスのprepareメソッドを通じて利用することになる、
> ということになるのでしょうかね？
事実上そうなります。
そういったクラスはPDOに限らず多々ありますよ。

naktak · Answer

> これを、$stmt-> で呼び出せているのが、どうしてなのかがよく分からずにいます。
$conn->prepare($sql)によってPDOStatementクラスでインスタンス化された
オブジェクトが戻り値になっているからです。
つまり、PDO::prepareメソッドでは、内部でPDOStatementオブジェクトを生成しています。
http://jp.php.net/manual/ja/pdo.prepare.php

PDOStatementクラスはプリペアドステートメントの準備が行われてから初めて操作
できるものです。
bindParamメソッドに関して言えば、以下の例にあるように、プリペアドステートメントで
指定したパラメータ名にマッピングして値を設定します。
http://jp.php.net/manual/ja/pdostatement.bindparam.php

executeメソッドに関しても、準備の出来てないプリペアドステートメントに対して
実行など出来るはずがありません。
http://jp.php.net/manual/ja/pdostatement.execute.php

事実上、そういう事が実行可能なように、指定されたクエリをプリペアドステートメントとして
準備を行うのがprepareメソッドになります。

つまり、PDOStatementクラスは、プリペアドステートメントの準備が
行われていなければ意味のないクラスです。
ですからnew PDOStatementとしても意味がありませんし、誤った利用を
助長してしまいます。
何の脈絡もなく突然外部からインスタンス化されても、プリペアドステー
トメントの準備が行えていませんからPDOStatementクラスとしては一切
動作することが出来ません。
その為、『PDOStatementはPDO::prepare()より取得する』という制限が
存在するわけです。

PDOクラスのprepareメソッドについて。

■prepareメソッドが自分で作成したprivate領域にある情報等々、PDOのメンバ変数がpublicかprotectedなのかprivateなのかを知るすべ

この回答への補足

＞これら２つは、

＞質問１と質問２なので、そちらに主眼を置いて頂けると嬉しいです。

この回答への補足

ちょっと横からのちゃちゃいれのようになってしまいますが

この回答への補足

２つにする理由は、対象の絞り込みと役割の違いというところかな。

この回答への補足

SQLiteのオブジェクト指向言語型スタイルも同じ作りなので、オブジェクト指向についての理解を深めるのがよいかと思いますが、

この回答への補足

＃１です。

> これを、$stmt-> で呼び出せているのが、どうしてなのかがよく分からずにいます。

この回答への補足

似たような質問が見つかりました

関連するカテゴリからQ&Aを探す

デイリーランキングこのカテゴリの人気デイリーQ&Aランキング

マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング