MongoCursor::fields

クエリのフィールドを設定する

説明

public MongoCursor MongoCursor::fields ( array $f )

フィールドは "fieldname" : bool 形式で指定します。 true はそのフィールドを返すこと、そして false はそのフィールドを返さないことを意味します。 1 および 0 を、それぞれ true および false のかわりに使うこともできます。

"summary" フィールドだけを返すようにするには次のようにします。


<?php

$cursor->fields(array("summary" => true));

?>

"hidden" 以外のすべてのフィールドを返すには次のようにします。


<?php

$cursor->fields(array("hidden" => false));

?>

パラメータ

f: 返したい (あるいは返したくない) フィールド。

返り値

このカーソルを返します。

エラー / 例外

このカーソルの反復処理が始まっている場合、あるいはスカラー型の引数を渡した場合に MongoCursorException をスローします。