PDOStatement::bindParam

發行項
01/10/2024

將參數繫結至 SQL 陳述式中的具名或問號預留位置。

語法

  
bool PDOStatement::bindParam($parameter, &$variable[, $data_type[, $length[, $driver_options]]]);

參數

$parameter：(混合的) 參數識別碼。若是使用具名預留位置的陳述式，使用參數名稱 (:name)。若是使用問號語法的已備妥陳述式，則是以 1 起始之索引的參數。

&$variable：要系結至 SQL 語句參數之 PHP 變數的（mixed）名稱。

$data_type：選擇性 (整數) PDO::PARAM_* 常數。預設值是 PDO::PARAM_STR。

$length：資料類型的選擇性 (整數) 長度。您可以指定 PDO::SQLSRV_PARAM_OUT_DEFAULT_SIZE，以指出在 $data_type 中使用 PDO::PARAM_INT 或 PDO::PARAM_BOOL 時的預設大小。

$driver_options：選擇性 (混合) 驅動程式特定選項。例如，您可以指定 PDO::SQLSRV_ENCODING_UTF8，以 UTF-8 編碼的字串形式將資料行繫結至變數。

傳回值

如果成功，則為 TRUE，否則為 FALSE。

備註

將 Null 資料繫結至屬於 varbinary、binary 或 varbinary(max) 類型的伺服器資料行時，您應使用 $driver_options 指定二進位編碼 (PDO::SQLSRV_ENCODING_BINARY)。如需編碼常數的詳細資訊，請參閱常數。

已在 Microsoft Drivers for PHP for SQL Server 2.0 版中新增 PDO 支援。

參數範例

此程式碼範例說明在 $contact 繫結至參數之後，變更值並將會使傳入查詢中的值隨之變更。

<?php  
$database = "AdventureWorks";  
$server = "(local)";  
$conn = new PDO("sqlsrv:server=$server ; Database = $database", "", "");  
  
$contact = "Sales Agent";  
$stmt = $conn->prepare("select * from Person.ContactType where name = ?");  
$stmt->bindParam(1, $contact);  
$contact = "Owner";  
$stmt->execute();  
  
while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {  
   print "$row[Name]\n\n";  
}  
  
$stmt = null;  
$contact = "Sales Agent";  
$stmt = $conn->prepare("select * from Person.ContactType where name = :contact");  
$stmt->bindParam(':contact', $contact);  
$contact = "Owner";  
$stmt->execute();  
  
while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {  
   print "$row[Name]\n\n";  
}  
?>

輸出參數範例

此程式碼範例說明如何存取輸出參數。

<?php  
$database = "Test";  
$server = "(local)";  
$conn = new PDO("sqlsrv:server=$server ; Database = $database", "", "");  
  
$input1 = 'bb';  
  
$stmt = $conn->prepare("select ? = count(*) from Sys.tables");  
$stmt->bindParam(1, $input1, PDO::PARAM_STR, 10);  
$stmt->execute();  
echo $input1;  
?>

注意

當輸出參數繫結至 bigint 類型時，如果值最後可能超過 integer 的範圍，則搭配 PDO::SQLSRV_PARAM_OUT_DEFAULT_SIZE 使用 PDO::PARAM_INT 可能導致「值超出範圍」例外狀況。因此，請改為使用預設的 PDO::PARAM_STR 並提供結果字串的大小，在大部分情況下為 21。其為任何 bigint 值的最大位數數目 (包含負號)。

輸入/輸出範例

此程式碼範例說明如何使用輸入/輸出參數。

<?php  
   $database = "AdventureWorks";  
   $server = "(local)";  
   $dbh = new PDO("sqlsrv:server=$server ; Database = $database", "", "");  
  
   $dbh->query("IF OBJECT_ID('dbo.sp_ReverseString', 'P') IS NOT NULL DROP PROCEDURE dbo.sp_ReverseString");  
   $dbh->query("CREATE PROCEDURE dbo.sp_ReverseString @String as VARCHAR(2048) OUTPUT as SELECT @String = REVERSE(@String)");  
   $stmt = $dbh->prepare("EXEC dbo.sp_ReverseString ?");  
   $string = "123456789";  
   $stmt->bindParam(1, $string, PDO::PARAM_STR | PDO::PARAM_INPUT_OUTPUT, 2048);  
   $stmt->execute();  
   print $string;   // Expect 987654321  
?>

注意

建議在將值繫結至 decimal 或 numeric 資料行時使用字串作為輸入，以確保精確度與正確性，因為 PHP 所具備的浮點數 $英文$ 精確度有限。這同樣適用於 bigint 資料行，尤其當值不在某個整數的範圍內時。

十進位輸入範例

此程式碼範例示範如何繫結十進位值作為輸入參數。

<?php  
$database = "Test";  
$server = "(local)";  
$conn = new PDO("sqlsrv:server=$server ; Database = $database", "", "");  

// Assume TestTable exists with a decimal field 
$input = "9223372036854.80000";
$stmt = $conn->prepare("INSERT INTO TestTable (DecimalCol) VALUES (?)");
// by default it is PDO::PARAM_STR, rounding of a large input value may
// occur if PDO::PARAM_INT is specified
$stmt->bindParam(1, $input, PDO::PARAM_STR);
$stmt->execute();

另請參閱

PDOStatement 類別

PDO