Docs Menu

MongoDB\Model\CollectionInfo::getCappedMax()

バージョン 1.9 以降非推奨

MongoDB\Model\CollectionInfo::getCappedMax()

Capped コレクションのドキュメント制限を返します。 これは、 MongoDB\Database::createCollection()maxオプションと相関します。

function getCappedMax(): integer|null

Capped コレクションのドキュメント数。 コレクションに上限が設けられていない場合は、 nullが返されます。

このメソッドは非推奨となり、代わりにMongoDB\Model\CollectionInfo::getOptions()を使用し、 maxキーにアクセスします。

<?php
$info = new CollectionInfo([
'name' => 'foo',
'options' => [
'capped' => true,
'size' => 1048576,
'max' => 100,
]
]);
var_dump($info->getCappedMax());

出力は次のようになります。

int(100)