(NFC) CRM_Utils_Hook - Tweak description of crypto()

civicrm · Dec 18, 2020 · 2eb3939 · 2eb3939
1 parent 4971af2
commit 2eb3939
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php
@@ -1760,9 +1760,12 @@ public static function alterTemplateFile($formName, &$form, $context, &$tplName)
   }
 
   /**
-   * Initialize the cryptographic service.
+   * Register cryptographic resources, such as keys and cipher-suites.
    *
-   * This may be used to register additional keys or cipher-suites.
+   * Ex: $crypto->addSymmetricKey([
+   *   'key' => hash_hkdf('sha256', 'abcd1234'),
+   *   'suite' => 'aes-cbc-hs',
+   * ]);
    *
    * @param \Civi\Crypto\CryptoRegistry $crypto
    *