array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'mongodb-driver-cursor.settypemap.php', 1 => 'MongoDB\\Driver\\Cursor::setTypeMap', 2 => 'Sets a type map to use for BSON unserialization', ), 'up' => array ( 0 => 'class.mongodb-driver-cursor.php', 1 => 'MongoDB\\Driver\\Cursor', ), 'prev' => array ( 0 => 'mongodb-driver-cursor.rewind.php', 1 => 'MongoDB\\Driver\\Cursor::rewind', ), 'next' => array ( 0 => 'mongodb-driver-cursor.toarray.php', 1 => 'MongoDB\\Driver\\Cursor::toArray', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/mongodb/mongodb/driver/cursor/settypemap.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

MongoDB\Driver\Cursor::setTypeMap

(mongodb >=1.0.0)

MongoDB\Driver\Cursor::setTypeMap — Sets a type map to use for BSON unserialization

Description

final public MongoDB\Driver\Cursor::setTypeMap(array $typemap): void

Sets the type map configuration to use when unserializing the BSON results into PHP values.

Parameters

typeMap (array)

Type map configuration.

Return Values

No value is returned.

Errors/Exceptions

When iterating over the cursor, the following exceptions can also be thrown due to an incorrect type map configuration:

Examples

Example #1 MongoDB\Driver\Cursor::setTypeMap() example

<?php

$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");

$bulk = new MongoDB\Driver\BulkWrite;
$id = $bulk->insert(['x' => 1]);
$manager->executeBulkWrite('db.collection', $bulk);

$query = new MongoDB\Driver\Query(['_id' => $id]);
$cursor = $manager->executeQuery('db.collection', $query);
$cursor->setTypeMap(['root' => 'array']);

foreach ($cursor as $document) {
var_dump($document);
}

?>

The above example will output something similar to:

array(2) {
  ["_id"]=>
  object(MongoDB\BSON\ObjectId)#6 (1) {
    ["oid"]=>
    string(24) "56424fb76118fd3267180741"
  }
  ["x"]=>
  int(1)
}

See Also