pg_fetch_object
(PHP 4, PHP 5, PHP 7, PHP 8)
pg_fetch_object — 行をオブジェクトとして得る
説明
PgSql\Result
$result
,?int
$row
= null
,string
$class
= "stdClass",array
$constructor_args
= []): object|false
pg_fetch_object() は、取得した行のフィールド名に 対応するプロパティを有するオブジェクトを返します。オプションとして、 指定したクラスのコンストラクタにパラメータを渡してインスタンス化する ことも可能です。
注意: この関数は、 NULL フィールドに PHPの
null
値を設定します。
速度面では、この関数は pg_fetch_array() と同じであり、 pg_fetch_row() とほとんど同じ程度です (違いはわずかです)。
パラメータ
result
-
pg_query()、pg_query_params() や (様々な関数がありますが、特に) pg_execute() が返した PgSql\Result クラスのインスタンス。
row
-
取得する行番号。最初の行は 0 です。省略したり
null
を指定したりした場合は、 次の行を取得します。 class
-
インスタンス化し、プロパティを設定して戻り値とするクラスの名前。 指定しない場合は stdClass オブジェクトが返されます。
constructor_args
-
class
オブジェクトのコンストラクタに 渡すオプションの配列。
戻り値
結果の各フィールドに対応する属性を持つ object を返します。
データベースの NULL
値は null
として返します。
row
が結果の行数より大きい場合・行が存在しない場合
、そしてそれ以外のエラーが発生した場合は false
を返します。
エラー / 例外
constructor_args
が空ではないのに、
クラスにコンストラクタが存在しない場合、
ValueError がスローされます。
変更履歴
バージョン | 説明 |
---|---|
8.3.0 |
constructor_args が空ではないのに、
クラスにコンストラクタが存在しない場合、
ValueError がスローされるようになりました。
これより前のバージョンでは、Exception がスローされていました。
|
8.1.0 |
result は、PgSql\Result
クラスのインスタンスを期待するようになりました。
これより前のバージョンでは、リソース を期待していました。
|
例
例1 pg_fetch_object() の例
<?php
$database = "store";
$db_conn = pg_connect("host=localhost port=5432 dbname=$database");
if (!$db_conn) {
echo "Failed connecting to postgres database $database\n";
exit;
}
$qu = pg_query($db_conn, "SELECT * FROM books ORDER BY author");
while ($data = pg_fetch_object($qu)) {
echo $data->author . " (";
echo $data->year . "): ";
echo $data->title . "<br />";
}
pg_free_result($qu);
pg_close($db_conn);
?>
参考
- pg_query() - クエリを実行する
- pg_fetch_array() - 行を配列として取得する
- pg_fetch_assoc() - 行を連想配列として取得する
- pg_fetch_row() - 数値添字の配列として行を得る
- pg_fetch_result() - 結果インスタンスから値を返す
User Contributed Notes 8 notes
PostgreSQL boolean true becomes string "t"
PostgreSQL boolean false becomes string "f"
This is ambiguous, and leads to code duplication. I wonder why aren't the types correctly typed when fetching values. We could at least have an optional parameter to enable that.
If you're wanting to use objects for your results, but are put off because you can't seem to apply a function to each field of the result (like stripslashes for example), try this code:
<?php
// Code to connect, do query etc etc...
$row = pg_fetch_object($result);
$vars = get_object_vars($row);
foreach ( $vars as $key => $var )
{
$row->{$key} = stripslashes($var);
}
?>
I noticed that many people use FOR loops to extract query data. This is the method I use to extract data.
<?php
@$members = pg_query($db_conn, 'SELECT id,name FROM boards.members ORDER BY name;');
if ($members AND pg_num_rows($members)) {
while ($member = pg_fetch_object($members)) {
echo $member->name.' ('.$member->id.')';
}
}
?>
If an error occurs (or nothing is returned) in the above code nothing will output. An ELSE clause can be added to the IF to handle query errors (or nothing being returned). Or a seperate check can be performed for the event that nothing is returned by using an ELSEIF clause.
I like this method because it doesn't use any temporary counter variables.
The result_type arg is either invalid or incorrectly documented, since the "result_type is optional..." paragraph is copied verbatim from pg_fetch_array, and the PGSQL_NUM option is in conflict with the preceding paragraph's, "you can only access the data by the field names, and not by their
offsets."
When you retrieve the contents of a "timestamp with timezone" field, this will set the environment's timezone variables. Therefore, this is dangerous:
$s=$row->mydatefield;
$unixtimestamp=postgresqltimestamp2unix($s);
echo date("Y-m-d H:i:s",$unixtimestamp);
Here, postgresqltimestamp2unix is a function that converts the postgresql timestamp to Unix. The retrieval of the field data in the first line of the example above will influence the timezone used in date() in the third line.
This isn't all that useful. If you do, for example, foreach($row as $field) then you still get every value twice!
You can do something like this, though:
foreach ($line as $key => $cell){
if (! is_numeric($key)){
echo "<td>$key $cell</td>";
}
}
is is_numeric strict enough?
Getting db results as object.
<?php
$qry = pg_query("SELECT * FROM users");
$rows = array();
while ($fch = pg_fetch_object($qry)) {
$rows[] = $fch;
}
// or
$rows = array_map(function($a){
return (object) $a;
}, (array) pg_fetch_all($qry));
?>
Something I have learned to use:
$result=$pg_query (...);
$num = pg_numrows($result);
for($count=0;$count < $num && $data=pg_fetch_object($result,$count);$count++)
{
printf("<tr>\n");
printf(" <td>%s</td>\n",$data->foo);
printf(" <td>%s</td>\n",$data->bar);
printf("</tr>\n");
}