PHPackages                             mdeschermeier/bitflags - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. mdeschermeier/bitflags

ActiveLibrary

mdeschermeier/bitflags
======================

16PHP

Since Jul 26Pushed 8y ago1 watchersCompare

[ Source](https://github.com/mdeschermeier/bitflags)[ Packagist](https://packagist.org/packages/mdeschermeier/bitflags)[ RSS](/packages/mdeschermeier-bitflags/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

BitFlags
========

[](#bitflags)

A small class to compress down boolean flags into a single integer.

General Info
------------

[](#general-info)

### Installation

[](#installation)

#### Composer

[](#composer)

Probably the simplest way to get this up and running in your project.

`composer require mdeschermeier\bitflags`

...and you're done!

#### Manual Install

[](#manual-install)

Also pretty easy-peasy. Just drop the file located in the `src` directory (it's just the one file) wherever you want it to live and add the line:

`require_once "path/to/where/you/put/BitFlags.php";`

to the file you want to include this class into.

#### Namespace

[](#namespace)

Don't forget to use the namespace!

`use mdeschermeier\bitflags\BitFlags;`

### Contacting Me

[](#contacting-me)

The best place to get my attention is the Issue Tracker (if there's an issue, of course). If there isn't anything broken, but are looking for some more information or have some questions, please feel free to email me at .

IMPORTANT!
----------

[](#important)

While this class is more-or-less set it and forget it, there is one gotcha that I've identified that could potentially cause some problems.

**Order Matters:** This class utilizes associative arrays in order to allow you to reference the flags you set by name. In order to make this work, each flag is assigned a bit position in the order it is processed - meaning that if you use this class to generate a number, store that number in a DB, then later attempt to instantiate the class again using that stored value, your array needs to match what it was in the first place or your numbers will be off.

**For Example**:

```
 $Arr1 = ['Flag_1' => true, 'Flag_2' => false, 'Flag_3' => true];
 $Arr2 = ['Flag_2' => false, 'Flag_1' => true, 'Flag_3' => true];

 $BF1 = new BitFlags($Arr1);
 $BF2 = new BitFlags($Arr2);

 $intVal1 = $BF1->getCompressedFlags();
 $intVal2 = $BF2->getCompressedFlags();

 echo "intVal1: ".$intVal1."\n";
 echo "intVal2: ".$intVal2."\n";

```

**Output:**

```
intVal1: 5
intVal2: 6

```

Things should be okay if you want to *add* to your flag array, however - just so long as you are appending your additions to the end of your array.

Now, it should be noted that with the capability of manually setting the integer value of the flags with `setCompressedFlags()`, you *could*probably alter your arrays however you like and just update the values if you wanted. I'm not saying I *recommend* this, but hey, I'm a Readme doc, not a cop. Go nutsy if you're feelin' gutsy.

Methods
-------

[](#methods)

### Constructor

[](#constructor)

###### **$initFlagArray** - Associative Array *(Optional)*

[](#initflagarray---associative-array-optional)

Initializes flags passed into the constructor. Left empty or passing `null` simply initializes an empty array. If an array is passed into the constructor that is too large for the system to handle (greater than 63 or 31 elements on 64-bit or 32-bit systems, respectively), an Exception is thrown.

### *void* setFlags($flagArray)

[](#void-setflagsflagarray)

###### **$flagArray** - Associative Array

[](#flagarray---associative-array)

Assigns flags specified in `$flagArray` to a bit and sets the bit to the appropriate value, as determined by the `$flagArray` element. Will throw an Exception if the number of `$flagArray` elements exceed the maximum value allowed by your system architecture (*64-bit:* 63, *32-bit:* 31).

### *mixed* getFlagPosition($flag)

[](#mixed-getflagpositionflag)

###### **$flag** - String

[](#flag---string)

Returns the bit position of the specified `$flag` parameter. Returns `false` if flag does not exist.

### *boolean* toggleFlag($flag)

[](#boolean-toggleflagflag)

###### **$flag** - String

[](#flag---string-1)

Toggles the bit associated with the specified `$flag` parameter. Returns `true` on success, and `false` on failure.

### *mixed* getFlagSetting($flag)

[](#mixed-getflagsettingflag)

###### **$flag** - String

[](#flag---string-2)

Retrieves current stored setting for flag bit identified by `$flag`. Returns `null` in the event the flag does not exist.

### *void* enableAllFlags()

[](#void-enableallflags)

###### **None**

[](#none)

Does just what it says on the tin: Flips all assigned bits to `1`.

### *void* disableAllFlags()

[](#void-disableallflags)

###### **None**

[](#none-1)

*Also* does what the name implies: Flips all assigned bits to `0`.

### *integer* getCompressedFlags()

[](#integer-getcompressedflags)

###### **None**

[](#none-2)

Returns integer value of all enabled/disabled flags.

### *boolean* setCompressedFlags()

[](#boolean-setcompressedflags)

###### **None**

[](#none-3)

Manually sets the integer value of all enabled/disabled flags.

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/61b7964010e3dcdf9b0778bef21c176b17f139301537989179c35b27a4bbc81c?d=identicon)[mdeschermeier](/maintainers/mdeschermeier)

---

Top Contributors

[![mdeschermeier](https://avatars.githubusercontent.com/u/16123463?v=4)](https://github.com/mdeschermeier "mdeschermeier (8 commits)")

### Embed Badge

![Health badge](/badges/mdeschermeier-bitflags/health.svg)

```
[![Health](https://phpackages.com/badges/mdeschermeier-bitflags/health.svg)](https://phpackages.com/packages/mdeschermeier-bitflags)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)