sqlsrv_fetch_object
データの次の行を PHP オブジェクトとして取得します。
構文
sqlsrv_fetch_object( resource $stmt [, string $className [, array $ctorParams[, row[, ]offset]]])
パラメータ
$stmt: 実行されるステートメントに対応するステートメント リソース。
$className [オプション]: インスタンス化するクラスの名前を指定する文字列。$className パラメーターの値が指定されていない場合、PHP stdClass のインスタンスがインスタンス化されます。
$ctorParams [オプション]: $className パラメーターで指定されたクラスのコンストラクターに渡された値を格納する配列。指定したクラスのコンストラクターがパラメーター値を受け取る場合、sqlsrv_fetch_object の呼び出し時に $ctorParams パラメーターを使用する必要があります。
row [オプション]: Version 1.1 で追加されました。スクロール可能なカーソルを使用する、結果セット内のアクセス対象行を指定する、次のいずれかの値です。row を指定する場合は、$className および $ctorParams に null を指定する必要がある場合でも、$className および $ctorParams を明示的に指定する必要があります。
- SQLSRV_SCROLL_NEXT
- SQLSRV_SCROLL_PRIOR
- SQLSRV_SCROLL_FIRST
- SQLSRV_SCROLL_LAST
- SQLSRV_SCROLL_ABSOLUTE
- SQLSRV_SCROLL_RELATIVE
これらの値の詳細については、「カーソルの種類の指定と行の選択」を参照してください。スクロール可能なカーソルのサポートは、SQL Server Driver for PHP Version 1.1 で追加されました。
offset [オプション]: 取得する行を指定するには、SQLSRV_SCROLL_ABSOLUTE および SQLSRV_SCROLL_RELATIVE を共に使用します。結果セット内の最初のレコードは 0 です。
戻り値
結果セットのフィールド名に対応するプロパティを持つ PHP オブジェクト。プロパティ値には、対応する結果セットのフィールド値が格納されます。省略可能な $className パラメーターで指定されたクラスが存在しないか、指定されたステートメントに関連付けられたアクティブな結果セットがない場合は、false が返されます。取得する行が残っていない場合は null が返されます。
返されるオブジェクト内の値のデータ型は、既定の PHP データ型になります。既定の PHP データ型の詳細については、「既定の PHP データ型」を参照してください。
解説
省略可能な $className パラメーターでクラス名が指定された場合、このクラスの型のオブジェクトがインスタンス化されます。クラスのプロパティの名前が結果セットのフィールド名と同じ場合、対応する結果セットの値がプロパティに適用されます。結果セットのフィールド名がクラスのプロパティと異なる場合、結果セットのフィールド名を持つプロパティがオブジェクトに追加され、結果セットの値がプロパティに適用されます。$className パラメーターを使用した sqlsrv_fetch_object の呼び出しの詳細については、「データをオブジェクトとして取得する方法」を参照してください。
名前のないフィールドが返された場合、sqlsrv_fetch_object によってフィールド値が破棄され、警告が発行されます。例として、データベース テーブルに値を挿入し、サーバーで生成される主キーを取得する、次の Transact-SQL ステートメントについて考えてみます。
INSERT INTO Production.ProductPhoto (LargePhoto) VALUES (?);
SELECT SCOPE_IDENTITY()
このクエリから返される結果を sqlsrv_fetch_object で取得すると、SELECT SCOPE_IDENTITY() から返される値が破棄され、警告が発行されます。これを回避するため、Transact-SQL ステートメントで、返されるフィールドの名前を指定できます。以下は、Transact-SQL で列名を指定する 1 つの方法です。
SELECT SCOPE_IDENTITY() AS PictureID
例
次の例では、結果セットの各行を PHP オブジェクトとして取得します。この例では、SQL Server と AdventureWorks データベースがローカル コンピューターにインストールされていることを前提としています。この例をコマンド ラインから実行した場合、すべての出力はコンソールに書き込まれます。
<?php
/* Connect to the local server using Windows Authentication and
specify the AdventureWorks database as the database in use. */
$serverName = "(local)";
$connectionInfo = array( "Database"=>"AdventureWorks");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false )
{
echo "Could not connect.\n";
die( print_r( sqlsrv_errors(), true));
}
/* Set up and execute the query. */
$tsql = "SELECT FirstName, LastName
FROM Person.Contact
WHERE LastName='Alan'";
$stmt = sqlsrv_query( $conn, $tsql);
if( $stmt === false )
{
echo "Error in query preparation/execution.\n";
die( print_r( sqlsrv_errors(), true));
}
/* Retrieve each row as a PHP object and display the results.*/
while( $obj = sqlsrv_fetch_object( $stmt))
{
echo $obj->LastName.", ".$obj->FirstName."\n";
}
/* Free statement and connection resources. */
sqlsrv_free_stmt( $stmt);
sqlsrv_close( $conn);
?>