• API Documentation >
• Enumeration Classes >
• MongoDB\Model\CollectionInfo::isCapped()

MongoDB\Model\CollectionInfo::isCapped()

Deprecated since version 1.9.

Definition

MongoDB\Model\CollectionInfo::isCapped

Return whether the collection is a capped collection.

copy

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

copy

<?php

$info = new CollectionInfo([
    'name' => 'foo',
    'options' => [
        'capped' => true,
        'size' => 1048576,
   ]
]);

var_dump($info->isCapped());

The output would then resemble:

copy

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

←   MongoDB\Model\CollectionInfo::getType() MongoDB\Model\DatabaseInfo::getName()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.