diff options
| author | Anatol Belski <ab@php.net> | 2020-12-13 16:36:57 +0100 |
|---|---|---|
| committer | Anatol Belski <ab@php.net> | 2020-12-13 16:46:32 +0100 |
| commit | c6d3c68fb4d35f85fe45481e5f7d63a9ec68bb6d (patch) | |
| tree | a730b0b8d40bc436cdb96d015bf939238b92f31f /UPGRADING | |
| parent | 110b4e90946b6d46864c54c0e15b7a0deb6ad4b3 (diff) | |
| download | php-git-c6d3c68fb4d35f85fe45481e5f7d63a9ec68bb6d.tar.gz | |
UPGRADING: Document algorithm specific hash options [ci skip]
Signed-off-by: Anatol Belski <ab@php.net>
Diffstat (limited to 'UPGRADING')
| -rw-r--r-- | UPGRADING | 19 |
1 files changed, 18 insertions, 1 deletions
@@ -24,12 +24,29 @@ PHP 8.1 UPGRADE NOTES ======================================== - hash: - . Added MurmurHash3 with streaming support. The following variants are implemented + . The following functions have changed signatures: + + - function hash(string $algo, string $data, bool $binary = false, array $options = []): string|false {} + - function hash_file(string $algo, string $filename, bool $binary = false, array $options = []): string|false {} + - function hash_init(string $algo, int $flags = 0, string $key = "", array $options = []): HashContext {} + + The additional `$options` argument can be used to pass algorithm specific data. + + . Added MurmurHash3 with streaming support. The following variants are implemented: - murmur3a, 32-bit hash - murmur3c, 128-bit hash for x86 - murmur3f, 128-bit hash for x64 + The initial hash state can be passed through the `seed` key in the `$options` array, for example: + + ```php + $h = hash("murmur3f", $data, options: ["seed" => 42]); + echo $h, "\n"; + ``` + + A valid seed value is within the range from 0 to the plaform defined UINT_MAX, usually 4294967295. + ======================================== 3. Changes in SAPI modules ======================================== |