<!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>Provides an array or document to serialize as BSON</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.mongodb-bson-serializable.html">MongoDB\BSON\Serializable</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.mongodb-bson-unserializable.html">MongoDB\BSON\Unserializable</a></div> <div class="up"><a href="class.mongodb-bson-serializable.html">MongoDB\BSON\Serializable</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb-bson-serializable.bsonserialize" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB\BSON\Serializable::bsonSerialize</h1> <p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\BSON\Serializable::bsonSerialize</span> — <span class="dc-title">Provides an array or document to serialize as BSON</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb-bson-serializable.bsonserialize-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type"><span class="type array|object">array|object</span></span> <span class="methodname"><strong>MongoDB\BSON\Serializable::bsonSerialize</strong></span> ( <span class="methodparam">void</span> )</div> <p class="para rdfs-comment"> Called during serialization of the object to BSON. The method must return an <span class="type"><a href="language.types.array.html" class="type array">array</a></span> or <strong class="classname">stdClass</strong>. </p> <p class="para"> Root documents (e.g. a <span class="interfacename"><a href="class.mongodb-bson-serializable.html" class="interfacename">MongoDB\BSON\Serializable</a></span> passed to <span class="function"><a href="function.mongodb.bson-fromphp.html" class="function">MongoDB\BSON\fromPHP()</a></span>) will always be serialized as a BSON document. For field values, associative arrays and <strong class="classname">stdClass</strong> instances will be serialized as a BSON document and sequential arrays (i.e. sequential, numeric indexes starting at <em>0</em>) will be serialized as a BSON array. </p> <p class="para"> Users are encouraged to include an <span class="property">_id</span> property (e.g. a <a href="class.mongodb-bson-objectid.html" class="classname">MongoDB\BSON\ObjectId</a> initialized in your constructor) when returning data for a BSON root document; otherwise, the driver or database will need to generate a <a href="class.mongodb-bson-objectid.html" class="classname">MongoDB\BSON\ObjectId</a> when inserting or upserting the document, respectively. </p> </div> <div class="refsect1 parameters" id="refsect1-mongodb-bson-serializable.bsonserialize-parameters"> <h3 class="title">Parameters</h3> <p class="para">This function has no parameters.</p> </div> <div class="refsect1 returnvalues" id="refsect1-mongodb-bson-serializable.bsonserialize-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> An <span class="type"><a href="language.types.array.html" class="type array">array</a></span> or <strong class="classname">stdClass</strong> to be serialized as a BSON array or document. </p> </div> <div class="refsect1 examples" id="refsect1-mongodb-bson-serializable.bsonserialize-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1782"> <p><strong>Example #1 <span class="function"><strong>MongoDB\BSON\Serializable::bsonSerialize()</strong></span> returning an associative array for root document</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">class </span><span style="color: #0000BB">MyDocument </span><span style="color: #007700">implements </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">Serializable<br /></span><span style="color: #007700">{<br /> private </span><span style="color: #0000BB">$id</span><span style="color: #007700">;<br /><br /> function </span><span style="color: #0000BB">__construct</span><span style="color: #007700">()<br /> {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">id </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">ObjectId</span><span style="color: #007700">;<br /> }<br /><br /> function </span><span style="color: #0000BB">bsonSerialize</span><span style="color: #007700">()<br /> {<br /> return [</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">id</span><span style="color: #007700">, </span><span style="color: #DD0000">'foo' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">];<br /> }<br />}<br /><br /></span><span style="color: #0000BB">$bson </span><span style="color: #007700">= </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">fromPHP</span><span style="color: #007700">(new </span><span style="color: #0000BB">MyDocument</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">toJSON</span><span style="color: #007700">(</span><span style="color: #0000BB">$bson</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<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> { "_id" : { "$oid" : "56cccdcada14d8755a58c591" }, "foo" : "bar" } </pre></div> </div> </div> <div class="example" id="example-1783"> <p><strong>Example #2 <span class="function"><strong>MongoDB\BSON\Serializable::bsonSerialize()</strong></span> returning a sequential array for root document</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">class </span><span style="color: #0000BB">MyArray </span><span style="color: #007700">implements </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">Serializable<br /></span><span style="color: #007700">{<br /> function </span><span style="color: #0000BB">bsonSerialize</span><span style="color: #007700">()<br /> {<br /> return [</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">];<br /> }<br />}<br /><br /></span><span style="color: #0000BB">$bson </span><span style="color: #007700">= </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">fromPHP</span><span style="color: #007700">(new </span><span style="color: #0000BB">MyArray</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">toJSON</span><span style="color: #007700">(</span><span style="color: #0000BB">$bson</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> { "0" : 1, "1" : 2, "2" : 3 } </pre></div> </div> </div> <div class="example" id="example-1784"> <p><strong>Example #3 <span class="function"><strong>MongoDB\BSON\Serializable::bsonSerialize()</strong></span> returning an associative array for document field</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">class </span><span style="color: #0000BB">MyDocument </span><span style="color: #007700">implements </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">Serializable<br /></span><span style="color: #007700">{<br /> function </span><span style="color: #0000BB">bsonSerialize</span><span style="color: #007700">()<br /> {<br /> return [</span><span style="color: #DD0000">'foo' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">];<br /> }<br />}<br /><br /></span><span style="color: #0000BB">$value </span><span style="color: #007700">= [</span><span style="color: #DD0000">'document' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MyDocument</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$bson </span><span style="color: #007700">= </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">fromPHP</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">toJSON</span><span style="color: #007700">(</span><span style="color: #0000BB">$bson</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> { "document" : { "foo" : "bar" } } </pre></div> </div> </div> <div class="example" id="example-1785"> <p><strong>Example #4 <span class="function"><strong>MongoDB\BSON\Serializable::bsonSerialize()</strong></span> returning a sequential array for document field</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">class </span><span style="color: #0000BB">MyArray </span><span style="color: #007700">implements </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">Serializable<br /></span><span style="color: #007700">{<br /> function </span><span style="color: #0000BB">bsonSerialize</span><span style="color: #007700">()<br /> {<br /> return [</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">];<br /> }<br />}<br /><br /></span><span style="color: #0000BB">$value </span><span style="color: #007700">= [</span><span style="color: #DD0000">'array' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">MyArray</span><span style="color: #007700">];<br /></span><span style="color: #0000BB">$bson </span><span style="color: #007700">= </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">fromPHP</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">BSON</span><span style="color: #007700">\</span><span style="color: #0000BB">toJSON</span><span style="color: #007700">(</span><span style="color: #0000BB">$bson</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> { "array" : [ 1, 2, 3 ] } </pre></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-mongodb-bson-serializable.bsonserialize-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><span class="function"><a href="mongodb-bson-unserializable.bsonunserialize.html" class="function" rel="rdfs-seeAlso">MongoDB\BSON\Unserializable::bsonUnserialize()</a> - Constructs the object from a BSON array or document</span></li> <li class="member"><span class="interfacename"><a href="class.mongodb-bson-persistable.html" class="interfacename">MongoDB\BSON\Persistable</a></span></li> <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="class.mongodb-bson-serializable.html">MongoDB\BSON\Serializable</a></div> <div class="next" style="text-align: right; float: right;"><a href="class.mongodb-bson-unserializable.html">MongoDB\BSON\Unserializable</a></div> <div class="up"><a href="class.mongodb-bson-serializable.html">MongoDB\BSON\Serializable</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>