PHP Manual
MongoDB\Driver\ClientEncryption
Gets a key document by an alternate name

MongoDB\Driver\ClientEncryption::getKeyByAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::getKeyByAltName — Gets a key document by an alternate name

Description

final public MongoDB\Driver\ClientEncryption::getKeyByAltName(string $keyAltName): ?object

Finds a single key document in the key vault collection with the given alternate name keyAltName.

Parameters

keyAltName: Alternate name for the key document.

Return Values

Returns the key document, or null if no document matched.

Errors/Exceptions

Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
Throws MongoDB\Driver\Exception\ConnectionException if connection to the server fails (for reasons other than authentication).
Throws MongoDB\Driver\Exception\AuthenticationException if authentication is needed and fails.
Throws MongoDB\Driver\Exception\RuntimeException on other errors.

See Also

MongoDB\Driver\ClientEncryption::addKeyAltName() - Adds an alternate name to a key document
MongoDB\Driver\ClientEncryption::removeKeyAltName() - Removes an alternate name from a key document