(PHP 5, PECL OCI8 >= 1.1.0)
oci_define_by_name — PHP の変数を、クエリで取得するカラムに関連づける
$statement
, string $column_name
, mixed &$variable
[, int $type = SQLT_CHR
] )PHP の変数を、 oci_fetch() で取得するクエリのカラムに関連づけます。
oci_define_by_name() は、 oci_execute() を実行する前にコールしなければなりません。
statement
oci_parse() で作成して oci_execute() で実行した有効な OCI8 ステートメント ID、 あるいは REF CURSOR ステートメント ID。
column_name
クエリで使用するカラム名。
Oracle のデフォルトである大文字小文字を区別しないカラム名では大文字を使います。 大文字小文字を区別するカラム名の場合は、正確なカラム名を使います。
variable
返されるカラムの値を格納する PHP 変数。
type
返されるデータの型。一般的には不要です。 Oracle 式のデータ変換は行われないことに注意しましょう。たとえば、 SQLT_INT は無視され、返されるデータの型は SQLT_CHR のままとなります。
オプションで、 oci_new_descriptor() を使って LOB/ROWID/BFILE の領域を確保することもできます。
成功した場合に TRUE を、失敗した場合に FALSE を返します。
例1 oci_define_by_name() の例
<?php
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
if (!$conn) {
$e = oci_error();
trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}
$sql = 'SELECT location_id, city FROM locations WHERE location_id < 1200';
$stid = oci_parse($conn, $sql);
// 実行する前に定義しなければなりません
oci_define_by_name($stid, 'LOCATION_ID', $locid);
oci_define_by_name($stid, 'CITY', $city);
oci_execute($stid);
// フェッチするたびに、さきほど定義した変数に次の行のデータが格納されます
while (oci_fetch($stid)) {
echo "Location id $locid is $city<br>\n";
}
// 表示:
// Location id 1000 is Roma
// Location id 1100 is Venice
oci_free_statement($stid);
oci_close($conn);
?>
例2 oci_define_by_name() での大文字小文字を区別するカラム名の使用
<?php
/*
実行する前に、大文字小文字を区別するカラム名のテーブルを作っておきます
CREATE TABLE mytab (id NUMBER, "MyDescription" VARCHAR2(30));
INSERT INTO mytab (id, "MyDescription") values (1, 'Iced Coffee');
COMMIT;
*/
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
if (!$conn) {
$e = oci_error();
trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}
$stid = oci_parse($conn, 'SELECT * FROM mytab');
// 大文字小文字を区別しないカラム名の場合は、大文字を使います
oci_define_by_name($stid, 'ID', $id);
// 大文字小文字を区別するカラム名の場合は、カラム名にあわせます
oci_define_by_name($stid, 'MyDescription', $mydesc);
oci_execute($stid);
while (oci_fetch($stid)) {
echo "id $id is $mydesc<br>\n";
}
// 表示:
// id 1 is Iced Coffee
oci_free_statement($stid);
oci_close($conn);
?>
例3 oci_define_by_name() での LOB カラムの使用
<?php
/*
実行する前にテーブルを作ります
CREATE TABLE mytab (id NUMBER, fruit CLOB);
INSERT INTO mytab (id, fruit) values (1, 'apple');
INSERT INTO mytab (id, fruit) values (2, 'orange');
COMMIT;
*/
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
if (!$conn) {
$e = oci_error();
trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}
$stid = oci_parse($conn, 'SELECT * FROM mytab');
// 実行する前に定義しなければなりません
oci_define_by_name($stid, 'ID', $id);
oci_define_by_name($stid, 'FRUIT', $fruit); // $fruit will become a LOB descriptor
oci_execute($stid);
while (oci_fetch($stid)) {
echo $id . " is " . $fruit->load(100) . "<br>\n";
}
// 表示:
// 1 is apple
// 2 is orange
$fruit->free();
oci_free_statement($stid);
oci_close($conn);
?>
例4 oci_define_by_name() での型の明示
<?php
/*
実行する前にテーブルを作ります
CREATE TABLE mytab (id NUMBER, fruit CLOB);
INSERT INTO mytab (id, fruit) values (1, 'apple');
INSERT INTO mytab (id, fruit) values (2, 'orange');
COMMIT;
*/
$conn = oci_connect('hr', 'welcome', 'localhost/XE');
if (!$conn) {
$e = oci_error();
trigger_error(htmlentities($e['message'], ENT_QUOTES), E_USER_ERROR);
}
$stid = oci_parse($conn, 'SELECT * FROM mytab');
// 実行する前に定義しなければなりません
oci_define_by_name($stid, 'ID', $id);
$fruit = oci_new_descriptor($conn, OCI_D_LOB);
oci_define_by_name($stid, 'FRUIT', $fruit, OCI_D_CLOB);
oci_execute($stid);
while (oci_fetch($stid)) {
echo $id . " is " . $fruit->load(100) . "<br>\n";
}
// 表示:
// 1 is apple
// 2 is orange
$fruit->free();
oci_free_statement($stid);
oci_close($conn);
?>
注意:
PHP 5.0.0 より前のバージョンでは、かわりに ocidefinebyname() を使用します。 現在のバージョンでは、古い関数名もまだ使えます。 しかし、これは廃止予定であり非推奨です。