データベース関係クラスの使用(1) DB編
DBクラス
DBクラスは、a-blog cmsで使用しているデータベースへの接続を支援するクラスです。
インスタンスの作成
// DBクラス DB = DB::singleton(dsn());
dsn関数は、a-blog cmsの組み込み関数で、config.server.phpに保存されているデータベース情報を、連想配列で返します。以降のサンプルで紹介されている箇所以外で、使用することはほとんどありません。
クエリーの発行
基本的なクエリーの発行と、結果を全件取得するサンプルを下記に示します。
$DB = DB::singleton(dsn()); $q = '`SELECT * FROM `acms_entry` LIMIT 0, 10'; /** * query * @param string $query * @param string $mode * @return mixed $response */ // クエリーの結果を全件取得する $all = $DB->query($q, 'all');
クエリー発行の各モードの挙動
queryメソッドは、複数のモードを持ちます。それぞれのモードで、返り値が異なります。
all - 結果から全行を取得
結果を多次元配列として、全行取得します。
$q = '`SELECT * FROM `acms_entry` LIMIT 0, 10';
$all = $DB->query($q, 'all');
var_dump($all);
/*
dumpの結果
array(10)(
[0] => array(21)(
'entry_id' => 1,
'entry_title' => 'サンプルレコード',
'entry_code' => 'entry-1.html',
...
),
[1] => array(21)(
'entry_id' => 2,
'entry_title' => 'サンプルレコード2',
'entry_code' => 'entry-2.html',
...
),
[2] => array(21)(
'entry_id' => 3,
'entry_title' => 'サンプルレコード3',
'entry_code' => 'entry-3.html',
...
),
...
);
*/row - 結果から1行を取得
結果から1行のみ取得します。結果が複数行だった場合は、先頭の1行を連想配列で返します。
$q = '`SELECT * FROM `acms_entry` WHERE `entry_id` = 1';
$row = $DB->query($q, 'row');
var_dump($row);
/*
dumpの結果
array(21)(
'entry_id' => 1,
'entry_title' => 'サンプルレコード',
'entry_code' => 'entry-1.html',
...
)
*/one - 結果から1つの値を取得
結果から1つの値を取得します。結果が複数列をもつ場合は、先頭列の値を取得します。また、結果が複数行であった場合は、先頭の1行が対象行となります。
$q = '`SELECT `entry_title` FROM `acms_entry` WHERE `entry_id` = 1'; $one = $DB->query($q, 'one'); var_dump($row); /* dumpの結果 string "サンプルレコード" */
fetch - 結果を1行ずつ取得
結果を1行ずつ取得できるように、クエリーの結果をDBインスタンス内で保持します。保持された結果は、fetchメソッドで1行ずつ取得します。
fetchメソッドの返り値はrowモードと同じ挙動を示しますが、取得すべき結果が無くなった場合は、falseを返します。
$q = '`SELECT * FROM `acms_entry` LIMIT 0, 10';
$DB->query($q, 'fetch');
/**
* fetch
* @param string $query
* @return array $row
*/
while ( $row = $DB->fetch($q) ) {
echo $row['entry_title']."\r\n";
}
/*
echo の結果
サンプルレコード
サンプルレコード2
サンプルレコード3
...
..
.
*/exec - クエリーの成否をbooleanで取得
クエリーの成否のみをbooleanで返します。INSERT、UPDATE、DELETEなどの発行時に使用します。
$q = 'INSERT INTO acms_entry (col1, col2, col3....) VALUES(val1, val2, val3...);'
$res = $DB->query($q, 'exec');
if ( $res == true ) {
// success
} else {
// fail
}