<!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>The MongoDB\BSON\Javascript class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-bson-decimal128.unserialize.html">MongoDB\BSON\Decimal128::unserialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-javascript.construct.html">MongoDB\BSON\Javascript::__construct</a></div>
<div class="up"><a href="book.bson.html">MongoDB\BSON</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongodb-bson-javascript" class="reference">
<h1 class="title">The MongoDB\BSON\Javascript class</h1>
<div class="partintro"><p class="verinfo">(mongodb >=1.0.0)</p>
<div class="section" id="mongodb-bson-javascript.intro">
<h2 class="title">Introduction</h2>
<p class="para">
BSON type for Javascript code. An optional scope document may be specified
that maps identifiers to values and defines the scope in which the code
should be evaluated by the server.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
This BSON type is mainly used when executing database commands that take a
Javascript function as a parameter, such as
<a href="https://docs.mongodb.com/manual/reference/command/mapReduce/" class="link external">» mapReduce</a>.
</span>
</p></blockquote>
</div>
<div class="section" id="mongodb-bson-javascript.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="modifier">final</span>
<span class="ooclass">
<strong class="classname">MongoDB\BSON\Javascript</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.mongodb-bson-javascriptinterface.html" class="interfacename">MongoDB\BSON\JavascriptInterface</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.mongodb-bson-type.html" class="interfacename">MongoDB\BSON\Type</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-bson-javascript.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$code</code></span>
[, <span class="methodparam"><span class="type"><span class="type array|object">array|object</span></span> <code class="parameter">$scope</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-javascript.getcode.html" class="methodname">getCode</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">object|null</span> <span class="methodname"><a href="mongodb-bson-javascript.getscope.html" class="methodname">getScope</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="mongodb-bson-javascript.jsonserialize.html" class="methodname">jsonSerialize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-javascript.serialize.html" class="methodname">serialize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongodb-bson-javascript.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-bson-javascript.unserialize.html" class="methodname">unserialize</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$serialized</code></span>
)</div>
}</div>
</div>
<div class="section">
<h2 class="title">Changelog</h2>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.2.0</td>
<td>
Implements <span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span> and
<span class="interfacename"><a href="class.jsonserializable.html" class="interfacename">JsonSerializable</a></span>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-bson-javascript.construct.html">MongoDB\BSON\Javascript::__construct</a> — Construct a new Javascript</li><li><a href="mongodb-bson-javascript.getcode.html">MongoDB\BSON\Javascript::getCode</a> — Returns the Javascript's code</li><li><a href="mongodb-bson-javascript.getscope.html">MongoDB\BSON\Javascript::getScope</a> — Returns the Javascript's scope document</li><li><a href="mongodb-bson-javascript.jsonserialize.html">MongoDB\BSON\Javascript::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="mongodb-bson-javascript.serialize.html">MongoDB\BSON\Javascript::serialize</a> — Serialize a Javascript</li><li><a href="mongodb-bson-javascript.tostring.html">MongoDB\BSON\Javascript::__toString</a> — Returns the Javascript's code</li><li><a href="mongodb-bson-javascript.unserialize.html">MongoDB\BSON\Javascript::unserialize</a> — Unserialize a Javascript</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-bson-decimal128.unserialize.html">MongoDB\BSON\Decimal128::unserialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-bson-javascript.construct.html">MongoDB\BSON\Javascript::__construct</a></div>
<div class="up"><a href="book.bson.html">MongoDB\BSON</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
