DB_common::setOption()
DB_common::setOption() – PEAR DB の実行時オプションを設定する
Synopsis
integer setOption (
string $option
,
mixed $value
)
Description
PEAR DB の実行時オプションを設定します。
Parameter
-
string
$option
-
設定するオプションの名前。
-
mixed
$value
-
オプションに設定する値。
オプション |
データ型 |
デフォルト値 |
説明 |
autofree
|
boolean
|
FALSE
|
結果の行がなくなった場合、自動的に結果を開放しますか?
|
debug
|
integer
|
0
|
デバッグレベル
|
persistent
|
boolean
|
FALSE
|
接続は持続的ですか?
|
portability
|
integer
|
DB_PORTABILITY_NONE
|
移植性モードの定数。ビット演算で処理されます。機能を追加する際には
| を、削除する際には ^
を使用します。詳細な情報は、以下の例と
"導入 - 移植性" を参照ください。
|
seqname_format
|
string
|
%s_seq
|
シーケンス名に使用される、sprintf() の書式指定文字列。これは、
createSequence()、
nextID() および
dropSequence() に渡されるシーケンス名に
適用されます。
|
|
ssl
|
boolean
|
FALSE
|
接続に ssl を使用しますか?
|
Return value
integer - 成功した場合に DB_OK、
失敗した場合に DB_Error オブジェクトを返します。
Throws
Possible PEAR_Error values
エラーコード |
エラーメッセージ |
原因 |
対応法 |
NULL |
unknown option
|
指定されたオプションは存在しません。
|
$option
の記述に間違いがないかを調べます。
|
Note
This function can not be called
statically.
Example
<?php
// $db という名前の DB オブジェクトを取得しているとします...
$db->setOption('autofree', true);
?>
移植性モード「小文字化」および「トリム」を指定する
<?php
// $db という名前の DB オブジェクトを取得しているとします...
$db->setOption('portability',
DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_RTRIM);
?>
<?php
// $db という名前の DB オブジェクトを取得しているとします...
$db->setOption('portability',
DB_PORTABILITY_ALL ^ DB_PORTABILITY_RTRIM);
?>