<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Sets a type map to use for BSON unserialization</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-cursor.isdead.html">MongoDB\Driver\Cursor::isDead</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-cursor.toarray.html">MongoDB\Driver\Cursor::toArray</a></div>
<div class="up"><a href="class.mongodb-driver-cursor.html">MongoDB\Driver\Cursor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-cursor.settypemap" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\Cursor::setTypeMap</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Cursor::setTypeMap</span> — <span class="dc-title">Sets a type map to use for BSON unserialization</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-cursor.settypemap-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>MongoDB\Driver\Cursor::setTypeMap</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$typemap</code></span>
)</div>
<p class="para rdfs-comment">
Sets the <a href="mongodb.persistence.deserialization.html#mongodb.persistence.typemaps" class="link">type map
configuration</a> to use when unserializing the BSON results into PHP
values.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-cursor.settypemap-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">typeMap</code> (<span class="type"><a href="language.types.array.html" class="type array">array</a></span>)</dt>
<dd>
<p class="para">
<a href="mongodb.persistence.deserialization.html#mongodb.persistence.typemaps" class="link">Type map configuration</a>.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-cursor.settypemap-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-cursor.settypemap-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li>
</ul>
<p class="para">
When iterating over the cursor, the following exceptions can also be thrown
due to an incorrect type map configuration:
<ul class="simplelist">
<li class="member">
Throws
<a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> if
a class in the type map cannot be instantiated or does not implement
<span class="interfacename"><a href="class.mongodb-bson-unserializable.html" class="interfacename">MongoDB\BSON\Unserializable</a></span>.
</li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodb-driver-cursor.settypemap-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1727">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\Cursor::setTypeMap()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">"mongodb://localhost:27017"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$bulk </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">BulkWrite</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$id </span><span style="color: #007700">= </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeBulkWrite</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Query</span><span style="color: #007700">([</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$id</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$query</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">setTypeMap</span><span style="color: #007700">([</span><span style="color: #DD0000">'root' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'array'</span><span style="color: #007700">]);<br /><br />foreach (</span><span style="color: #0000BB">$cursor </span><span style="color: #007700">as </span><span style="color: #0000BB">$document</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$document</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
["_id"]=>
object(MongoDB\BSON\ObjectId)#6 (1) {
["oid"]=>
string(24) "56424fb76118fd3267180741"
}
["x"]=>
int(1)
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-cursor.settypemap-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="mongodb.persistence.html" class="xref">Persisting Data</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-cursor.isdead.html">MongoDB\Driver\Cursor::isDead</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-cursor.toarray.html">MongoDB\Driver\Cursor::toArray</a></div>
<div class="up"><a href="class.mongodb-driver-cursor.html">MongoDB\Driver\Cursor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
