[DOC-CVS] [doc-en] master: ext/sodium: Fix return-value prose for 4 encrypt/stream functions that throw SodiumException instead of returning false (#5655)
[email protected] (Louis-Arnaud via GitHub) Thu, 9 Jul 2026 17:46:03 +0000
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Louis-Arnaud (lacatoire) Committer: GitHub (web-flow) Pusher: jordikroon Date: 2026-07-09T19:46:00+02:00 Commit: https://github.com/php/doc-en/commit/cc7976fa40eef4c07fc1e90813146be1503fb464 Raw diff: https://github.com/php/doc-en/commit/cc7976fa40eef4c07fc1e90813146be1503fb464.diff ext/sodium: Fix return-value prose for 4 encrypt/stream functions that throw SodiumException instead of returning false (#5655) Changed paths: M reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-encrypt.xml M reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-ietf-encrypt.xml M reference/sodium/functions/sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.xml M reference/sodium/functions/sodium-crypto-stream-xchacha20-xor-ic.xml Diff: diff --git a/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-encrypt.xml b/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-encrypt.xml index dfb3be07439c..ecc076741aaa 100644 --- a/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-encrypt.xml +++ b/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-encrypt.xml @@ -63,7 +63,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <simpara> - Returns the ciphertext and tag on success, &return.falseforfailure;. + Returns the ciphertext and authentication tag as a string of raw binary bytes. </simpara> </refsect1> diff --git a/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-ietf-encrypt.xml b/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-ietf-encrypt.xml index 18c9d962c1bd..98b9d2b27a09 100644 --- a/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-ietf-encrypt.xml +++ b/reference/sodium/functions/sodium-crypto-aead-chacha20poly1305-ietf-encrypt.xml @@ -66,7 +66,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <simpara> - Returns the ciphertext and tag on success, &return.falseforfailure;. + Returns the ciphertext and authentication tag as a string of raw binary bytes. </simpara> </refsect1> diff --git a/reference/sodium/functions/sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.xml b/reference/sodium/functions/sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.xml index 7cdcca7e58ca..11fa4711015d 100644 --- a/reference/sodium/functions/sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.xml +++ b/reference/sodium/functions/sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.xml @@ -67,7 +67,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <simpara> - Returns the ciphertext and tag on success, &return.falseforfailure;. + Returns the ciphertext and authentication tag as a string of raw binary bytes. </simpara> </refsect1> diff --git a/reference/sodium/functions/sodium-crypto-stream-xchacha20-xor-ic.xml b/reference/sodium/functions/sodium-crypto-stream-xchacha20-xor-ic.xml index a5184bb83891..ede0d60a62f0 100644 --- a/reference/sodium/functions/sodium-crypto-stream-xchacha20-xor-ic.xml +++ b/reference/sodium/functions/sodium-crypto-stream-xchacha20-xor-ic.xml @@ -71,7 +71,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <simpara> - Encrypted message, &return.falseforfailure;. + Encrypted message. </simpara> </refsect1>