MongoDB\Model\DatabaseInfo Class Reference

Inheritance diagram for MongoDB\Model\DatabaseInfo:

Public Member Functions
	__construct (array $info)
	__debugInfo ()
	Return the database info as an array.
	getName ()
	Return the database name.
	getSizeOnDisk ()
	Return the databases size on disk (in bytes).
	isEmpty ()
	Return whether the database is empty.
	offsetExists ($key)
	Check whether a field exists in the database information.
	offsetGet ($key)
	Return the field's value from the database information.
	offsetSet ($key, $value)
	Not supported.
	offsetUnset ($key)
	Not supported.

Constructor & Destructor Documentation

__construct()

MongoDB\Model\DatabaseInfo::__construct

(

array

$info

)

Parameters

array

$info

Database info

Member Function Documentation

__debugInfo()

MongoDB\Model\DatabaseInfo::__debugInfo

(

)

Return the database info as an array.

See also

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

Return values

array

getName()

MongoDB\Model\DatabaseInfo::getName

(

)

Return the database name.

Return values

string

getSizeOnDisk()

MongoDB\Model\DatabaseInfo::getSizeOnDisk

(

)

Return the databases size on disk (in bytes).

Return values

integer

isEmpty()

MongoDB\Model\DatabaseInfo::isEmpty

(

)

Return whether the database is empty.

Return values

boolean

offsetExists()

MongoDB\Model\DatabaseInfo::offsetExists

(

$key

)

Check whether a field exists in the database information.

See also

https://php.net/arrayaccess.offsetexists

Parameters

mixed

$key

Return values

boolean

offsetGet()

MongoDB\Model\DatabaseInfo::offsetGet

(

$key

)

Return the field's value from the database information.

See also

https://php.net/arrayaccess.offsetget

Parameters

mixed

$key

Return values

mixed

offsetSet()

MongoDB\Model\DatabaseInfo::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\DatabaseInfo::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/DatabaseInfo.php