yaroslavche / bitmask
BitMask, EnumBitMask
Installs: 34 283
Dependents: 2
Suggesters: 0
Security: 0
Stars: 31
Watchers: 3
Forks: 6
Open Issues: 2
Requires
- php: ^8.1
Requires (Dev)
README
BitMask
PHP library for working with bitmask values
Getting Started
Usually enough for checking bits:
define('READ', 1 << 0); define('WRITE', 1 << 1); define('EXECUTE', 1 << 2); $mask = READ | WRITE | EXECUTE; echo sprintf('mask: %d', $mask); // mask: 7 if ($mask & READ) {} // if $mask has a single bit READ $mask &= ~EXECUTE; // remove a single bit from the $mask $mask |= EXECUTE; // set a single bit to the $mask
But you can try other way with this package:
use BitMask\BitMask; // two arguments: integer mask (default: 0) and most significant bit for boundaries (default: null) $bitmask = new BitMask(READ | WRITE | EXECUTE); echo sprintf('mask: %d', $bitmask->get()); // mask: 7 if ($bitmask->has(READ)) {} $bitmask->remove(EXECUTE); $bitmask->set(EXECUTE);
Exists EnumBitMask, which allows the same using PHP enum:
use BitMask\EnumBitMask; enum Permissions { case READ; case WRITE; case EXECUTE; } // two arguments: required enum class-string and integer mask (default: 0) $bitmask = new EnumBitMask(Permissions::class, 0b111); echo sprintf('mask: %d', $bitmask->get()); // mask: 7 if ($bitmask->has(Permissions::READ)) {} $bitmask->remove(Permissions::EXECUTE); $bitmask->set(Permissions::EXECUTE); $bitmask->set(Unknown::Case); // throws an exception, only Permissions cases available
EnumBitMask
have a factory methods:
# Create a bit mask using one or multiple enum cases $bitmask = EnumBitMask::create(Permissions::class, Permissions::EXECUTE); # Create a bit mask using all enum cases $bitmask = EnumBitMask::all(Permissions::class); # Create a bit mask with no flags on (equivalent to create with no additional flags) $bitmask = EnumBitMask::none(Permissions::class); # Create a bit mask without specific flags $bitmask = EnumBitMask::without(Permissions::class, Permissions::EXECUTE);
Exists Bits helper with static methods:
use BitMask\Util\Bits; $mask = 7; // 1 << 0 | 1 << 1 | 1 << 2 $integerMostSignificantBit = Bits::getMostSignificantBit($mask); // int 2 $arraySetBitsIndexes = Bits::getSetBitsIndexes($mask); // array:3 [0, 1, 2] $arraySetBits = Bits::getSetBits($mask); // array:3 [1, 2, 4] $string = Bits::toString($mask); // string "111" $integerBit = Bits::indexToBit(16); // int 65536 $integerIndex = Bits::bitToIndex(65536); // int 16 $boolIsSingleBit = Bits::isSingleBit(8); // true
Installing
Install package via composer
composer require yaroslavche/bitmask
Contributing
Feel free to fork or contribute =)
CI build
$ composer ci:pack
Tests
PHPUnit
$ composer phpunit $ ./vendor/bin/phpunit
Infection
$ composer infection $ ./vendor/bin/infection --min-msi=100 --min-covered-msi=100
Benchmarks
$ composer phpbench $ ./vendor/bin/phpbench run benchmarks --report=default
Static analyzer and code style
PHPStan
$ composer phpstan $ ./vendor/bin/phpstan analyse src/ -c phpstan.neon --level=9 --no-progress -vvv --memory-limit=1024M
Psalm
$ composer psalm $ ./vendor/bin/psalm
PHP-CS
Code style check
$ composer phpcs-check $ ./vendor/bin/php-cs-fixer check --diff
Code style fix
$ composer phpcs-fix $ ./vendor/bin/php-cs-fixer fix
License
This project is licensed under the MIT License - see the LICENSE file for details