Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in
Toggle navigation
M
mongo-php-library
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
sinan
mongo-php-library
Commits
d777f5ff
Unverified
Commit
d777f5ff
authored
Jan 22, 2020
by
Andreas Braun
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
PHPLIB-512: Document createClientEncryption method
parent
5e76ca50
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
56 additions
and
0 deletions
+56
-0
apiargs-MongoDBClient-method-createClientEncryption-param.yaml
...gs-MongoDBClient-method-createClientEncryption-param.yaml
+4
-0
MongoDBClient.txt
docs/reference/class/MongoDBClient.txt
+1
-0
MongoDBClient-createClientEncryption.txt
...reference/method/MongoDBClient-createClientEncryption.txt
+51
-0
No files found.
docs/includes/apiargs-MongoDBClient-method-createClientEncryption-param.yaml
0 → 100644
View file @
d777f5ff
source
:
file
:
apiargs-common-param.yaml
ref
:
$options
...
docs/reference/class/MongoDBClient.txt
View file @
d777f5ff
...
@@ -30,6 +30,7 @@ Methods
...
@@ -30,6 +30,7 @@ Methods
/reference/method/MongoDBClient__construct
/reference/method/MongoDBClient__construct
/reference/method/MongoDBClient__get
/reference/method/MongoDBClient__get
/reference/method/MongoDBClient-createClientEncryption
/reference/method/MongoDBClient-dropDatabase
/reference/method/MongoDBClient-dropDatabase
/reference/method/MongoDBClient-getManager
/reference/method/MongoDBClient-getManager
/reference/method/MongoDBClient-getReadConcern
/reference/method/MongoDBClient-getReadConcern
...
...
docs/reference/method/MongoDBClient-createClientEncryption.txt
0 → 100644
View file @
d777f5ff
=========================================
MongoDB\\Client::createClientEncryption()
=========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. phpmethod:: MongoDB\\Client::createClientEncryption()
Returns a :php:`MongoDB\\Driver\\ClientEncryption <class.mongodb-driver-clientencryption>`
object for manual encryption and decryption of values.
.. code-block:: php
function createClientEncryption(array $options): MongoDB\Driver\ClientEncryption
This method has the following parameters:
.. include:: /includes/apiargs/MongoDBClient-method-createClientEncryption-param.rst
The ``$options`` parameter supports all options documented in the
:php:`extension manual <manual/en/mongodb-driver-manager.createclientencryption.php>`.
For the ``keyVaultClient`` option, an instance of :phpclass:`MongoDB\\Client`
is automatically unwrapped and the :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>`
instance is passed to the extension.
Return Values
-------------
A :php:`MongoDB\\Driver\\ClientEncryption <class.mongodb-driver-clientencryption>`
instance which can be used to encrypt and decrypt values.
Errors/Exceptions
-----------------
.. include:: /includes/extracts/error-invalidargumentexception.rst
.. include:: /includes/extracts/error-driver-invalidargumentexception.rst
See Also
--------
- :php:`MongoDB\\Driver\\Manager::createClientEncryption()
<manual/en/mongodb-driver-manager.createclientencryption.php>`
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment