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
$info = new CollectionInfo([
    'name' => 'foo',
    'options' => [
        'capped' => true,
        'size' => 1048576,
   ]
]);
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