mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 08:28:54 +00:00
MongoDB\Driver\ClientEncryption constructor
https://jira.mongodb.org/browse/PHPC-2097
This commit is contained in:
parent
5b3fc18be0
commit
2d23d655aa
3 changed files with 95 additions and 1 deletions
|
@ -0,0 +1,93 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<refentry xml:id="mongodb-driver-clientencryption.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>MongoDB\Driver\ClientEncryption::__construct</refname>
|
||||
<refpurpose>Create a new ClientEncryption object</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>final</modifier> <modifier>public</modifier> <methodname>MongoDB\Driver\ClientEncryption::__construct</methodname>
|
||||
<methodparam><type>array</type><parameter>options</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Constructs a new <classname>MongoDB\Driver\ClientEncryption</classname> object with the specified options.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>options</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<table>
|
||||
<title>options</title>
|
||||
<tgroup cols="3">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Option</entry>
|
||||
<entry>Type</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>keyVaultClient</entry>
|
||||
<entry><classname>MongoDB\Driver\Manager</classname></entry>
|
||||
<entry>The Manager used to route data key queries. This option is required (unlike with <function>MongoDB\Driver\Manager::createClientEncryption</function>).</entry>
|
||||
</row>
|
||||
&mongodb.option.encryption.keyVaultNamespace;
|
||||
&mongodb.option.encryption.kmsProviders;
|
||||
&mongodb.option.encryption.tlsOptions;
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="errors">
|
||||
&reftitle.errors;
|
||||
<simplelist>
|
||||
&mongodb.throws.argumentparsing;
|
||||
<member>Throws <classname>MongoDB\Driver\Exception\RuntimeException</classname> if the extension was compiled without libmongocrypt support</member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><function>MongoDB\Driver\Manager::createClientEncryption</function></member>
|
||||
<member><link xlink:href="&url.mongodb.docs;core/security-explicit-client-side-encryption/">Explicit (Manual) Client-Side Field Level Encryption</link> in the MongoDB manual</member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- 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
|
||||
-->
|
|
@ -107,7 +107,7 @@
|
|||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<simplelist>
|
||||
<member><classname>MongoDB\Driver\ClientEncryption</classname></member>
|
||||
<member><function>MongoDB\Driver\ClientEncryption::__construct</function></member>
|
||||
<member><link xlink:href="&url.mongodb.docs;core/security-explicit-client-side-encryption/">Explicit (Manual) Client-Side Field Level Encryption</link> in the MongoDB manual</member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
|
|
|
@ -28,6 +28,7 @@
|
|||
<!-- Classes and Methods -->
|
||||
|
||||
<function name='mongodb\driver\clientencryption' from='mongodb >=1.7.0'/>
|
||||
<function name='mongodb\driver\clientencryption::__construct' from='mongodb >=1.14.0'/>
|
||||
<function name='mongodb\driver\clientencryption::createdatakey' from='mongodb >=1.7.0'/>
|
||||
<function name='mongodb\driver\clientencryption::decrypt' from='mongodb >=1.7.0'/>
|
||||
<function name='mongodb\driver\clientencryption::encrypt' from='mongodb >=1.7.0'/>
|
||||
|
|
Loading…
Reference in a new issue