Docs Menu

Docs HomePHP Library Manual

MongoDB\Collection::__construct()

On this page

  • Definition
  • Errors/Exceptions
  • Behavior
  • See Also
MongoDB\\Collection::__construct()

Constructs a new Collection instance.

function __construct(
MongoDB\Driver\Manager $manager,
string $databaseName,
string $collectionName,
array $options = []
)

This constructor has the following parameters:

$manager : MongoDB\\Driver\\Manager
The Manager instance from the driver. The manager maintains connections between the driver and your MongoDB instances.
$databaseName : string
The name of the database.
$collectionName : string
The name of the collection.
$options : array

An array specifying the desired options.

Name
Type
Description
readConcern
The default read concern to use for collection operations. Defaults to the manager's read concern.
readPreference
The default read preference to use for collection operations. Defaults to the manager's read preference.
typeMap
array

Default type map to apply to cursors, which determines how BSON documents are converted to PHP values. The library uses the following type map by default:

[
'array' => 'MongoDB\Model\BSONArray',
'document' => 'MongoDB\Model\BSONDocument',
'root' => 'MongoDB\Model\BSONDocument',
]
writeConcern
The default write concern to use for collection operations. Defaults to the manager's write concern.

MongoDB\\Exception\\InvalidArgumentException for errors related to the parsing of parameters or options.

If you construct a Collection explicitly, the Collection inherits any options from the MongoDB\\Driver\\Manager object. If you select the Collection from a Client or Database object, the Collection inherits its options from that object.

←  MongoDB\Collection ClassMongoDB\Collection::aggregate() →