MongoDB\Model\CollectionInfo::isCapped()

Definition

MongoDB\Model\CollectionInfo::isCapped()

Return whether the collection is a capped collection.

function isCapped(): boolean

Return Values

A boolean indicating whether the collection is a capped collection.

This method is deprecated in favor of using MongoDB\Model\CollectionInfo::getOptions() and accessing the capped key.

Examples

<?php
$db = (new MongoDB\Client)->test;
// Creates a capped collection
$db->createCollection(
   'myCappedCollection',
   ['capped' => true, 'size' => 1048576]
);
// Retrieves whether the collection is capped
foreach ($db->listCollections(['filter' => ['name' => 'myCappedCollection']]) as $info) {
   var_dump($info->isCapped());
}

The output would then resemble:

bool(true)

See Also

• MongoDB\Model\CollectionInfo::getCappedMax()

• MongoDB\Model\CollectionInfo::getCappedSize()

• Capped Collections in the MongoDB manual

• listCollections command reference in the MongoDB manual