Recommend this page to a friend! |
Download |
Info | Documentation | Files | Install with Composer | Download | Reputation | Support forum | Blog | Links |
Ratings | Unique User Downloads | Download Rankings | ||||
Not yet rated by the users | Total: 59 | All time: 10,516 This week: 560 |
Version | License | PHP version | Categories | |||
php-bitwise-flags 1.0.0 | Custom (specified... | 5 | Data types, PHP 7 |
Description | Author | |
This package can manipulate sets of binary flag values. |
The number of flags you can use is limited to the architecture of your system, e.g.: 32 flags on a 32-bit system or 64 flags on 64-bit system. To store 64-bits flags in a database, you will need to store it as UNSIGNED BIGINT in MySQL.
Via composer:
composer require niko9911/bitwise-flags
Below some example usage code
<?php
declare(strict_types=1);
use Niko9911\Flags\Bits;
use Niko9911\Flags\Flags;
final class User extends Flags
{
public const BANNED = Bits::BIT_1; // 0x1
public const ADMIN = Bits::BIT_2; // 0x2
public const ACTIVATED = Bits::BIT_3; // 0x4
}
/ @var User|Flags $entity */
$entity = new User();
/ Usage when using single flag. */
$entity->addFlag(User::BANNED);
var_dump($entity->matchFlag(User::ADMIN)); // False
var_dump($entity->matchFlag(User::BANNED)); // True
$entity->removeFlag(User::BANNED);
var_dump($entity->matchFlag(User::BAR)); // False
/ Usage when using multiple flags. */
$entity->addFlag(User::ACTIVATED | User::ADMIN);
var_dump($entity->matchFlag(User::ACTIVATED)); // True
var_dump($entity->matchFlag(User::ACTIVATED | User::BANNED)); // False (Banned not set.)
var_dump($entity->matchFlag(User::ACTIVATED | User::ADMIN)); // True (Both set)
var_dump($entity->matchAnyFlag(User::ACTIVATED | User::BANNED)); // True. (One is set.)
/ Usage with flag names. */
// Flag name is taken from constant name
$entity = new User();
$entity->addFlag(User::BANNED | User::ADMIN | User::ACTIVATED);
var_dump($entity->getFlagNames()); // [Banned, Admin, Activated]
var_dump($entity->getFlagNames()); // // [Banned, Admin, Activated]
var_dump($entity->getFlagNames(User::ACTIVATED | User::BANNED)); // [Activated, Banned]
/ Overriding automatically defined flag names. */
final class UserWCustomNames extends BinaryFlags
{
public const BANNED = Bits::BIT_1;
public const ADMIN = Bits::BIT_2;
public const ACTIVATED = Bits::BIT_3;
// Implementing this specific function you can register
// flags with custom naming.
public static function registerFlags(): array
{
return [
static::BANNED => 'IsUserBanned',
static::ADMIN => 'IsUserAdmin',
static::ACTIVATED => 'IsUserActivated',
];
}
}
$entity = new UserWCustomNames();
$entity->addFlag(
UserWCustomNames::BANNED |
UserWCustomNames::ADMIN |
UserWCustomNames::ACTIVATED
);
var_dump($entity->getFlagNames());
// [
// 0 => IsUserBanned,
// 1 => IsUserAdmin,
// 2 => IsUserActivated,
// ]
Files (13) |
File | Role | Description | ||
---|---|---|---|---|
scripts (1 file) | ||||
src (3 files) | ||||
tests (1 file, 1 directory) | ||||
.php_cs.dist | Example | Example script | ||
composer.json | Data | Auxiliary data | ||
composer.lock | Data | Auxiliary data | ||
LICENSE | Lic. | License text | ||
phpunit.xml.dist | Data | Auxiliary data | ||
README.md | Doc. | Read me |
Files (13) | / | src |
File | Role | Description |
---|---|---|
Bits.php | Class | Class source |
Flags.php | Class | Class source |
FlagsTrait.php | Class | Class source |
Files (13) | / | tests | / | Stubs |
File | Role | Description |
---|---|---|
ExampleFlags.php | Class | Class source |
ExampleFlagsWithNames.php | Class | Class source |
The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page. |
Install with Composer |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.