[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] [doc-en] master: MongoDB: Document constructor parameters for ServerApi class
From:       Andreas Braun <noreply () php ! net>
Date:       2022-10-17 6:57:37
Message-ID: DaRoj9hns4bWH3aXyanXhYBDEDuUv27xHcozlkkNuNQ () main ! php ! net
[Download RAW message or body]

Author: Andreas Braun (alcaeus)
Date: 2022-10-17T09:02:59+02:00

Commit: https://github.com/php/doc-en/commit/a7b808a875840b8850631210ef2190d681b6edfa
Raw diff: https://github.com/php/doc-en/commit/a7b808a875840b8850631210ef2190d681b6edfa.diff


MongoDB: Document constructor parameters for ServerApi class

Changed paths:
  M  reference/mongodb/mongodb/driver/serverapi/construct.xml


Diff:

diff --git a/reference/mongodb/mongodb/driver/serverapi/construct.xml \
b/reference/mongodb/mongodb/driver/serverapi/construct.xml index \
                7c1304d915a..16543379199 100644
--- a/reference/mongodb/mongodb/driver/serverapi/construct.xml
+++ b/reference/mongodb/mongodb/driver/serverapi/construct.xml
@@ -25,7 +25,43 @@
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  &no.function.parameters;
+  <variablelist>
+   <varlistentry xml:id="mongodb-driver-serverapi.construct-version">
+    <term><parameter>version</parameter></term>
+    <listitem>
+     <para>
+      A server API version.
+     </para>
+     <para>
+      Supported API versions are provided as constants in
+      <classname>MongoDB\Driver\ServerApi</classname>. The only supported API
+      version is <constant>MongoDB\Driver\ServerApi::V1</constant>.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry xml:id="mongodb-driver-manager.construct-strict">
+    <term><parameter>strict</parameter></term>
+    <listitem>
+     <para>
+      If the <parameter>strict</parameter> parameter is set to &true;, the
+      server will yield an error for any command that is not part of the
+      specified API version. If no value is provided, the server default value
+      (&false;) is used.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry xml:id="mongodb-driver-manager.construct-deprecationErrors">
+    <term><parameter>deprecationErrors</parameter></term>
+    <listitem>
+     <para>
+      If the <parameter>deprecationErrors</parameter> parameter is set to &true;,
+      the server will yield an error when using a command that is deprecated in
+      the specified API version. If no value is provided, the server default value
+      (&false;) is used.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
  </refsect1>
 
 </refentry>

-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]