FFI bindings for libxxhash
This is an FFI binding of the
libxxHash library from xxHash for PHP.
You're here because:
- You want xxHash in PHP.
- You don't want to install an extension.
- You're fine with installing the
xxhashpackage on your system to get libxxHash.
- You want speed, or at least more speed than a pure PHP implementation of xxHash could get.
If so, you're in the right place.
You will obviously need the
In addition you will need
libffi, and enable FFI for PHP (You will therefore need PHP version 7.4 or above).
libxxhash needs to be v0.6.4 or above.
Here are some common ways to install:
- Arch GNU/Linux:
sudo pacman -S xxhash libffi
- Debian / Ubundu:
sudo apt install xxhash libffi
sudo dnf install xxhash libffi
sudo zypper install xxhash libffi
PHP has to be compiled with the
--with-ffi option, most distributions will have done this.
Locate the relevant
php.ini file on your system and make sure these two lines are present, uncommented:
Then, simply add the bindings to your project:
composer require necklace/xxhash-ffi
Let me hash already!
Alright, alright. I know what you want, and I got what you need. You've got files, we got hashes:
Hash a file
<?php use Necklace\XxHash\XxHash64; $xxh = new XxHash64; echo $xxh->hashFile('filename');
Hey man, I want the latest, fastest, and greatest!
This library supports the XXH3 algorithm, you can use this but beware; it's still labeled experimental : return values from this version are not comparable with other versions.
<?php use Necklace\XxHash\Xxh3\XxHash64; $xxh = new XxHash64; echo $xxh->hashFile('filename');
tests/ for more examples.
See COPYING or LICENSE.txt.
Clone and run
Remember to run
~/.config/composer/vendor/bin/php-cs-fixer fix src/
Run all tests with
php vendor/bin/phpunit from the top directory.
Test memory leaks in tests with