1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 07:42:10 +01:00
Files
archived-doc-en/reference/mongodb/bson/javascript.xml
Andreas Braun 4639881688 MongoDB: document changes in 2.0.0 (#4618)
* PHPC-2485: Remove support for legacy option types

* PHPC-2459: Remove support for float and string args to UTCDateTime::__construct

* PHPC-2447: Extend Iterator interface in CursorInterface

* PHPC-2441: Remove deprecated manager constructor options

* PHPC-2440: Remove deprecated query options

* PHPC-2417: Add UTCDateTimeInterface::toDateTimeImmutable

* PHPC-2402: Remove range_preview client encryption constants

* PHPC-2351: Remove CursorId class and change Cursor::getId() to return Int64

* PHPC-2348: Remove WriteException

* PHPC-2346: Remove BSON functions in favor of Document methods

* PHPC-2344: Remove SSLConnectionException

* PHPC-2248: Remove Serializable interface implementations

* PHPC-2144: WriteResult getters throw exception if unacknowledged

* Add language snippets for removed functionality changelog entries

* PHPC-1741: Remove getServer API and manager reference from APM event classes

* PHPC-1021: Remove ReadPreference integer constants

* Add changelog entries for enforced return types

* Remove breaking includes

* Fix duplicate XML tag

* Rename language snippet for clarity

* Note removed parameter for Cursor::getId

* Mention write results no longer returning null

* Fix XML errors

* Remove documentation for removed Serializable methods
2025-04-17 14:22:19 +02:00

132 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.mongodb-bson-javascript" role="class" 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>JsonSerializable</interfacename>
</oointerface>
<oointerface>
<interfacename>Stringable</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>
&mongodb.changelog.serializable-interface-removed;
<row>
<entry>PECL mongodb 1.12.0</entry>
<entry>
Implements <interfacename>Stringable</interfacename> for PHP 8.0+.
</entry>
</row>
<row>
<entry>PECL mongodb 1.3.0</entry>
<entry>
Implements <interfacename>MongoDB\BSON\JavascriptInterface</interfacename>.
</entry>
</row>
<row>
<entry>PECL mongodb 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;
</reference>
<!-- 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
-->