MongoCursor::count

(PECL mongo >=0.9.2)

MongoCursor::count — このクエリの結果の数を数える

説明

public MongoCursor::count ([ bool $foundOnly = FALSE ] ) : int

このメソッドはカーソルの状態には何の影響も及ぼしません。もしまだクエリを実行していないのなら、limit や skip を適用することもできます。結果の反復処理が始まっている場合は、このメソッドを実行してもカーソルの現在位置は変わりません。カーソルの最後まで達している場合は、このメソッドを実行してもカーソルをリセットしません。

パラメータ

foundOnly: カーソルの limit を送信し、制限に達した場合に count 関数への情報の送信をスキップします。

返り値

このカーソルのクエリが返すドキュメントの数を返します。

例

例1 MongoCursor::count() の例


<?php

$collection->insert(array('x'=>1));
$collection->insert(array('x'=>2));
$collection->insert(array('x'=>3));

$cursor = $collection->find();

var_dump($cursor->count());
var_dump($cursor->count(true));

$cursor->limit(2);

var_dump($cursor->count());
var_dump($cursor->count(true));

?>

上の例の出力は、たとえば以下のようになります。

int(3)
int(3)
int(3)
int(2)

エラー / 例外

データベースに接続できない場合に MongoConnectionException をスローします。