Download the PHP package pleonasm/bloom-filter without Composer
On this page you can find all versions of the php package pleonasm/bloom-filter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pleonasm/bloom-filter
More information about pleonasm/bloom-filter
Files in pleonasm/bloom-filter
Package bloom-filter
Short Description A pure PHP implementation of a Bloom Filter
License BSD-2-Clause
Informations about the package bloom-filter
A Bloom Filter for PHP
This is a well tested implementation of a Bloom Filter for PHP. It has the following features:
- Efficient memory use for bit array (as efficient as PHP can be anyway).
- A way to get a raw version of the filter for transport to other systems.
- Ability to restore said raw filter back into a usable one.
- Auto-calculates optimal hashing and bit array size based on desired set size and false-positive probability.
- Auto-generates hashing functions as needed.
Installation
Install via Composer (make sure you have composer in your path or in your project).
Put the following in your package.json:
Run composer install
.
Usage
Warnings On Serialization
As a note: using json_encode()
on a bloom filter object should work across
most systems. You can run in to trouble if are moving the filter between 64
and 32 bit systems (that will outright not work) or moving between
little-endian and big-endian systems (that should work, but I haven't tested
it).
Also note that json_encode()
will take the binary bit array and base64
encode it. So if you have a large array, it will get about 33% bigger on
serialization.
Other Notes
Under the hood, the hashing mechanism used is actually an HMAC of whatever algorithm you pick. In general, PHP's hash extension is not happy if you pick a non-cryptographically secure algo to calculate an HMAC so just don't do it with this library and everything will work just fine.
This may not come up if you're using PHP 7.1 specifically, but generally the hash you use must output at least 64 bits. Things like adler32 or crc32 not okay to use even if they don't throw an error in PHP 7.1.
Requirements
This project requires PHP 7.1 or newer. That said, version 1.0.2 of bloom-filter is available for PHP 5.4 to 7.0 and will work just fine.
License
You can find the license for this code in the LICENSE file.