sqlsrv_fetch_object
Ruft die nächste Datenzeile als PHP-Objekt ab.
Syntax
sqlsrv_fetch_object( resource $stmt [, string $className [, array $ctorParams[, row[, ]offset]]])
Parameter
$stmt: Hierbei handelt es sich um eine Anweisungsressource, die einer ausgeführten Anweisung entspricht.
$className (optional): Eine Zeichenfolge, die den Namen der zu instanziierenden Klassen angibt. Falls der Wert für den $className -Parameter nicht festgelegt ist, wird eine Instanz der PHP stdClass instanziiert.
$ctorParams (optional): Ein Array, das Werte enthält, die an den Konstruktor der Klasse übergeben werden, die durch den $className-Parameter angegeben wird. Falls der Konstruktor der angegebenen Klasse Parameterwerte akzeptiert, muss der $ctorParams -Parameter verwendet werden, wenn sqlsrv_fetch_objectaufgerufen wird.
row (optional): Einer der folgenden Werte, der die Zeile angibt, auf die in einem Resultset zugegriffen wird, das einen scrollfähigen Cursor verwendet. (Wenn row angegeben ist, müssen $className und $ctorParams explizit angegeben werden, selbst wenn Sie für $className und $ctorParams NULL angeben müssen.)
SQLSRV_SCROLL_NEXT
SQLSRV_SCROLL_PRIOR
SQLSRV_SCROLL_FIRST
SQLSRV_SCROLL_LAST
SQLSRV_SCROLL_ABSOLUTE
SQLSRV_SCROLL_RELATIVE
Weitere Informationen zu diesen Werten finden Sie unter Festlegen eines Cursortyps und Zeilenauswahl.
offset [OPTIONAL]: Dieser Wert wird zusammen mit „SQLSRV_SCROLL_ABSOLUTE“ und „SQLSRV_SCROLL_RELATIVE“ verwendet, um die abzurufende Zeile anzugeben. Der erste Datensatz im Resultset ist „0“.
Rückgabewert
Ein PHP-Objekt mit Eigenschaften, die zu den Feldnamen des Resultsets passen. Eigenschaftswerte werden mit den passenden Werten aus den Resultsetfeldern befüllt. Wenn die mit dem optionalen $className -Parameter spezifizierte Klasse nicht existiert, oder wenn es kein aktives Resultset zu der angegebenen Anweisung gibt, wird false zurückgegeben. Wenn keine weiteren Zeilen mehr abgerufen werden können, wird NULL zurückgegeben.
Der Datentyp eines Werts im zurückgegebenen Objekt wird der PHP-Standarddatentyp sein. Informationen zu PHP-Standarddatentypen finden Sie unter Default PHP Data Types.
Bemerkungen
Falls ein Klassenname mit dem optionalen $className -Parameter festgelegt ist, wird ein Objekt diesen Klassentyps instanziiert. Falls die Klasse Eigenschaften aufweist, deren Namen zu den Namen der Resultsetfelder passen, werden die entsprechenden Resultsetwerte auf die Eigenschaften angewendet. Falls ein Resultsetfeldname mit keiner Klasseneigenschaft übereinstimmt, wird dem Objekt eine Eigenschaft mit dem Resultsetfeldnamen hinzugefügt und der Wert aus dem Resultset wird auf die Eigenschaft angewendet.
Die folgenden Regeln gelten, wenn eine Klasse mit einem $className -Parameter spezifiziert wird:
Beim Abgleich wird die Groß- und Kleinschreibung beachtet. So stimmt beispielsweise der Eigenschaftenname „KundenId“ nicht mit dem Feldnamen „KundenID“ überein. In diesem Fall würde dem Objekt eine „KundenID“-Eigenschaft hinzugefügt und der Wert des Feldes „KundenID“ würde an die „KundenID“-Eigenschaft gegeben werden.
Der Abgleich erfolgt unabhängig von Zugriffsmodifizierern. Falls beispielsweise die spezifizierte Klasse eine private Eigenschaft mit demselben Namen wie ein Resultsetfeld hat, wird der Wert aus dem Resultsetfeld auf die Eigenschaft angewendet.
Klasseneigenschaftendatentypen werden ignoriert. Falls das Feld „KundenID“ im Resultset eine Zeichenfolge, aber die „KundenID“-Eigenschaft der Klasse ein Integer-Datentyp ist, wird der Zeichenfolgewert des Resultsets auf die „KundenID“-Eigenschaft geschrieben.
Falls die spezifizierte Klasse nicht existiert, gibt die Funktion false zurück und fügt der Fehlersammlung einen Fehler hinzu. Informationen zum Abrufen von Fehlerinformationen finden Sie unter sqlsrv_errors.
Falls ein Feld ohne Name zurückgegeben wird, wird sqlsrv_fetch_object den Wert des Feldes verwerfen und eine Warnung ausgeben. Betrachten Sie beispielsweise diese Transact-SQL-Anweisung, die einen Wert in eine Datenbanktabelle einfügt und den vom Server generierten Primärschlüssel abruft:
INSERT INTO Production.ProductPhoto (LargePhoto) VALUES (?);
SELECT SCOPE_IDENTITY()
Falls die Ergebnisse dieser Abfrage mit sqlsrv_fetch_objectabgerufen werden, wird der von SELECT SCOPE_IDENTITY() zurückgegebene Wert verworfen und eine Warnung ausgegeben. Um dies zu vermeiden, können Sie einen Namen für das zurückgegebene Feld in der Transact-SQL-Anweisung spezifizieren. Im Folgenden finden Sie eine Möglichkeit, einen Spaltennamen in Transact-SQL anzugeben:
SELECT SCOPE_IDENTITY() AS PictureID
Objektbeispiel
Im folgenden Beispiel wird jede Zeile eines Resultsets als PHP-Objekt abgerufen. Das Beispiel setzt voraus, dass SQL Server und die AdventureWorks-Datenbank auf dem lokalen Computer installiert sind. Wenn das Beispiel über die Befehlszeile ausgeführt wird, werden alle Ausgaben in die Konsole geschrieben.
<?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);
?>
Klassenbeispiel
Im folgenden Beispiel wird jede Zeile eines Resultsets als eine Instanz der im Skript definierten Product -Klasse abgerufen. Im Beispiel werden Produktinformationen aus den Tabellen Purchasing.PurchaseOrderDetail und Production.Product der AdventureWorks-Datenbank für Produkte mit einem angegebenen Fälligkeitsdatum (DueDate) und einer gelagerten Menge (StockQty), die kleiner als ein angegebener Wert ist, abgerufen. In diesem Beispiel sind einige der Regeln, die beim Spezifizieren einer Klasse in einem Aufruf an sqlsrv_fetch_objectzur Anwendung kommen, noch einmal deutlich herausgestellt:
Die $product -Variable ist eine Instanz der Product -Klasse, da „Produkt“ mit dem $className -Parameter spezifiziert wurde und die Product -Klasse existiert.
Die Name -Eigenschaft wird der $product -Instanz hinzugefügt, da die bestehende name -Eigenschaft nicht übereinstimmt.
Die Color -Eigenschaft wird der $product -Instanz hinzugefügt, weil es keine übereinstimmende Eigenschaft gibt.
Die private Eigenschaft UnitPrice wird mit dem Wert aus dem UnitPrice -Feld aufgefüllt.
Das Beispiel setzt voraus, dass SQL Server und die AdventureWorks-Datenbank auf dem lokalen Computer installiert sind. Wenn das Beispiel über die Befehlszeile ausgeführt wird, werden alle Ausgaben in die Konsole geschrieben.
<?php
/* Define the Product class. */
class Product
{
/* Constructor */
public function Product($ID)
{
$this->objID = $ID;
}
public $objID;
public $name;
public $StockedQty;
public $SafetyStockLevel;
private $UnitPrice;
function getPrice()
{
return $this->UnitPrice;
}
}
/* 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));
}
/* Define the query. */
$tsql = "SELECT Name,
SafetyStockLevel,
StockedQty,
UnitPrice,
Color
FROM Purchasing.PurchaseOrderDetail AS pdo
JOIN Production.Product AS p
ON pdo.ProductID = p.ProductID
WHERE pdo.StockedQty < ?
AND pdo.DueDate= ?";
/* Set the parameter values. */
$params = array(3, '2002-01-29');
/* Execute the query. */
$stmt = sqlsrv_query( $conn, $tsql, $params);
if ( $stmt )
{
echo "Statement executed.\n";
}
else
{
echo "Error in statement execution.\n";
die( print_r( sqlsrv_errors(), true));
}
/* Iterate through the result set, printing a row of data upon each
iteration. Note the following:
1) $product is an instance of the Product class.
2) The $ctorParams parameter is required in the call to
sqlsrv_fetch_object, because the Product class constructor is
explicity defined and requires parameter values.
3) The "Name" property is added to the $product instance because
the existing "name" property does not match.
4) The "Color" property is added to the $product instance
because there is no matching property.
5) The private property "UnitPrice" is populated with the value
of the "UnitPrice" field.*/
$i=0; //Used as the $objID in the Product class constructor.
while( $product = sqlsrv_fetch_object( $stmt, "Product", array($i)))
{
echo "Object ID: ".$product->objID."\n";
echo "Product Name: ".$product->Name."\n";
echo "Stocked Qty: ".$product->StockedQty."\n";
echo "Safety Stock Level: ".$product->SafetyStockLevel."\n";
echo "Product Color: ".$product->Color."\n";
echo "Unit Price: ".$product->getPrice()."\n";
echo "-----------------\n";
$i++;
}
/* Free statement and connection resources. */
sqlsrv_free_stmt( $stmt);
sqlsrv_close( $conn);
?>
Die sqlsrv_fetch_object -Funktion gibt immer die Daten gemäß der Default PHP Data Typesaufgerufen wird. Weitere Informationen zur Angabe des PHP-Datentyps finden Sie unter Vorgehensweise: Angeben von PHP-Datentypen.
Falls ein Feld ohne Name zurückgegeben wird, wird sqlsrv_fetch_object den Wert des Feldes verwerfen und eine Warnung ausgeben. Betrachten Sie beispielsweise diese Transact-SQL-Anweisung, die einen Wert in eine Datenbanktabelle einfügt und den vom Server generierten Primärschlüssel abruft:
INSERT INTO Production.ProductPhoto (LargePhoto) VALUES (?);
SELECT SCOPE_IDENTITY()
Falls die Ergebnisse dieser Abfrage mit sqlsrv_fetch_objectabgerufen werden, wird der von SELECT SCOPE_IDENTITY() zurückgegebene Wert verworfen und eine Warnung ausgegeben. Um dies zu vermeiden, können Sie einen Namen für das zurückgegebene Feld in der Transact-SQL-Anweisung spezifizieren. Im Folgenden finden Sie eine Möglichkeit, einen Spaltennamen in Transact-SQL anzugeben:
SELECT SCOPE_IDENTITY() AS PictureID