array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'mongodb-driver-clientencryption.removekeyaltname.php', 1 => 'MongoDB\\Driver\\ClientEncryption::removeKeyAltName', 2 => 'Removes an alternate name from a key document', ), 'up' => array ( 0 => 'class.mongodb-driver-clientencryption.php', 1 => 'MongoDB\\Driver\\ClientEncryption', ), 'prev' => array ( 0 => 'mongodb-driver-clientencryption.getkeys.php', 1 => 'MongoDB\\Driver\\ClientEncryption::getKeys', ), 'next' => array ( 0 => 'mongodb-driver-clientencryption.rewrapmanydatakey.php', 1 => 'MongoDB\\Driver\\ClientEncryption::rewrapManyDataKey', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/mongodb/mongodb/driver/clientencryption/removekeyaltname.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

MongoDB\Driver\ClientEncryption::removeKeyAltName

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::removeKeyAltName — Removes an alternate name from a key document

Description

final public MongoDB\Driver\ClientEncryption::removeKeyAltName(MongoDB\BSON\Binary $keyId, string $keyAltName): ?object

Removes keyAltName from the set of alternate names for the key document with the given UUID keyId.

Parameters

keyId
A MongoDB\BSON\Binary instance with subtype 4 (UUID) identifying the key document.
keyAltName
Alternate name to remove from the key document.

Return Values

Returns the previous version of the key document, or null if no document matched.

Errors/Exceptions

See Also