php-doc-en/reference/mongodb/bson/javascript.xml

119 lines
3.1 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.mongodb-bson-javascript" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MongoDB\BSON\Javascript class</title>
<titleabbrev>MongoDB\BSON\Javascript</titleabbrev>
<partintro>
<!-- {{{ MongoDB\BSON\Javascript intro -->
<section xml:id="mongodb-bson-javascript.intro">
&reftitle.intro;
<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.
</para>
<note>
<simpara>
This BSON type is mainly used when executing database commands that take a
Javascript function as a parameter, such as
<link xlink:href="&url.mongodb.docs;reference/command/mapReduce/">mapReduce</link>.
</simpara>
</note>
</section>
<!-- }}} -->
<section xml:id="mongodb-bson-javascript.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>MongoDB\BSON\Javascript</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<modifier>final</modifier>
<ooclass>
<classname>MongoDB\BSON\Javascript</classname>
</ooclass>
<oointerface>
<interfacename>MongoDB\BSON\JavascriptInterface</interfacename>
</oointerface>
<oointerface>
<interfacename>MongoDB\BSON\Type</interfacename>
</oointerface>
<oointerface>
<interfacename>Serializable</interfacename>
</oointerface>
<oointerface>
<interfacename>JsonSerializable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-bson-javascript')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
<section role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.2.0</entry>
<entry>
Implements <interfacename>Serializable</interfacename> and
<interfacename>JsonSerializable</interfacename>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
</partintro>
&reference.mongodb.bson.entities.javascript;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->