MongoDB\Model\CollectionInfo Class Reference

Inheritance diagram for MongoDB\Model\CollectionInfo:

Public Member Functions
	__construct (array $info)
	__debugInfo ()
	Return the collection info as an array.
	getCappedMax ()
	Return the maximum number of documents to keep in the capped collection.
	getCappedSize ()
	Return the maximum size (in bytes) of the capped collection.
	getIdIndex ()
	Return information about the _id index for the collection.
	getInfo ()
	Return the "info" property of the server response.
	getName ()
	Return the collection name.
	getOptions ()
	Return the collection options.
	getType ()
	Return the collection type.
	isCapped ()
	Return whether the collection is a capped collection.
	offsetExists ($key)
	Check whether a field exists in the collection information.
	offsetGet ($key)
	Return the field's value from the collection information.
	offsetSet ($key, $value)
	Not supported.
	offsetUnset ($key)
	Not supported.

Constructor & Destructor Documentation

__construct()

MongoDB\Model\CollectionInfo::__construct

(

array

$info

)

Parameters

array

$info

Collection info

Member Function Documentation

__debugInfo()

MongoDB\Model\CollectionInfo::__debugInfo

(

)

Return the collection info as an array.

See also

https://php.net/oop5.magic#language.oop5.magic.debuginfo

Return values

array

getCappedMax()

MongoDB\Model\CollectionInfo::getCappedMax

(

)

Return the maximum number of documents to keep in the capped collection.

Deprecated

1.0 Deprecated in favor of using getOptions

Return values

integer|null

getCappedSize()

MongoDB\Model\CollectionInfo::getCappedSize

(

)

Return the maximum size (in bytes) of the capped collection.

Deprecated

1.0 Deprecated in favor of using getOptions

Return values

integer|null

getInfo()

MongoDB\Model\CollectionInfo::getInfo

(

)

Return the "info" property of the server response.

See also

https://mongodb.com/docs/manual/reference/command/listCollections/#output

getName()

MongoDB\Model\CollectionInfo::getName

(

)

Return the collection name.

See also

https://mongodb.com/docs/manual/reference/command/listCollections/#output

Return values

string

getOptions()

MongoDB\Model\CollectionInfo::getOptions

(

)

Return the collection options.

See also

https://mongodb.com/docs/manual/reference/command/listCollections/#output

Return values

array

getType()

MongoDB\Model\CollectionInfo::getType

(

)

Return the collection type.

See also

https://mongodb.com/docs/manual/reference/command/listCollections/#output

isCapped()

MongoDB\Model\CollectionInfo::isCapped

(

)

Return whether the collection is a capped collection.

Deprecated

1.0 Deprecated in favor of using getOptions

Return values

boolean

offsetExists()

MongoDB\Model\CollectionInfo::offsetExists

(

$key

)

Check whether a field exists in the collection information.

See also

https://php.net/arrayaccess.offsetexists

Parameters

mixed

$key

Return values

boolean

offsetGet()

MongoDB\Model\CollectionInfo::offsetGet

(

$key

)

Return the field's value from the collection information.

See also

https://php.net/arrayaccess.offsetget

Parameters

mixed

$key

Return values

mixed

offsetSet()

MongoDB\Model\CollectionInfo::offsetSet	(		$key,
			$value )

Not supported.

See also

https://php.net/arrayaccess.offsetset

Parameters

mixed	$key
mixed	$value

Exceptions

BadMethodCallException

Return values

void

offsetUnset()

MongoDB\Model\CollectionInfo::offsetUnset

(

$key

)

Not supported.

See also

https://php.net/arrayaccess.offsetunset

Parameters

mixed

$key

Exceptions

BadMethodCallException

Return values

void

---

The documentation for this class was generated from the following file:

• cache/stores/mongodb/MongoDB/Model/CollectionInfo.php