MongoCursor::fields

(PECL mongo >=1.0.6)

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

説明

public MongoCursor::fields ( array $f ) : MongoCursor

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

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

<?php

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

?>

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

<?php

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

?>

パラメータ

f

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

返り値

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

エラー / 例外

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