Download the PHP package axetools/bitflagtrait without Composer
On this page you can find all versions of the php package axetools/bitflagtrait. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download axetools/bitflagtrait
More information about axetools/bitflagtrait
Files in axetools/bitflagtrait
Package bitflagtrait
Short Description A PHP trait to enable bitwise comparison of flags
License MIT
Informations about the package bitflagtrait
AxeTools/BitFlagTrait
This is a php class trait that will provide methods for performing simple bitwise operations.
This project uses Semantic Versioning.
Bitwise operators allow for manipulation and examination of specific bits within an integer.
The BitFlagTrait
gives simple methods for setting, getting and toggling the status of bits withing a reference
integer.
This can be used for storage of the state of multiple flags or utilizing flags for class settings
Installation
The preferred method of installation is via Composer. Run the following command to install the package and add it as
a requirement to your project's composer.json
:
Usage
The BitFlagTrait can be used with any class and will expose several protected methods that can be utilized to perform bitwise checks to a reference integer.
Example:
hasFlag()
The self::hasFlag()
static method to determine the current boolean value of a specific flag in the flagSet integer.
Description
Parameters
- flagSet
- The integer that contains the current flag status.
- flag
- The flag to check the status of.
Return Value
bool : the status of the flag contained in the flag status.
setFlag()
The self::setFlag()
static method to set the current boolean value of a specific flag in the flagSet integer.
Description
Parameters
- flagSet
- The integer that contains the current flag status. Passed by reference and will result in the updated integer
- flag
- The flag to set the value of.
- value
- The boolean value to set the flag position in the flag status integer.
Return Value
void
toggleFlag()
The self::toggleFlag()
static method to toggle the current boolean value of a specific flag in the flagSet integer
to it's opposite.
Description
Parameters
- flagSet
- The integer that contains the current flag status. Passed by reference and will result in the updated integer
- flag
- The flag to set the value of.
Return Value
void
Notice:
Be aware of the storage medium and data types available to the class you use the trait with. PHP is still deployed on some 32-bit systems. SQL small and medium integers have limited number of flags available due to the max size. Signed and unsigned SQL integers have different amount of flags available.