Navigation

MongoDB\Model\CollectionInfo::getCappedSize()

Deprecated since version 1.9.

Definition

MongoDB\Model\CollectionInfo::getCappedSize

Return the size limit for the capped collection in bytes. This correlates with the size option for MongoDB\Database::createCollection().

function getCappedSize(): integer|null

Return Values

The size limit for the capped collection in bytes. If the collection is not capped, null will be returned.

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

Examples

<?php

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

var_dump($info->getCappedSize());

The output would then resemble:

int(1048576)