https://github.com/pointybeard/helpers-functions-flags

A collection of functions for handling bitwise flags
https://github.com/pointybeard/helpers-functions-flags

Last synced: 9 days ago
JSON representation

A collection of functions for handling bitwise flags

• Host: GitHub
• URL: https://github.com/pointybeard/helpers-functions-flags
• Owner: pointybeard
• License: other
• Created: 2019-05-07T22:31:40.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-05-07T22:32:10.000Z (over 5 years ago)
• Last Synced: 2024-10-11T06:21:02.980Z (about 1 month ago)
• Language: PHP
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# PHP Helpers: Flag Functions

-   Version: v1.0.0

-   Date: May 08 2019

-   [Release notes](https://github.com/pointybeard/helpers-functions-flags/blob/master/CHANGELOG.md)

-   [GitHub repository](https://github.com/pointybeard/helpers-functions-flags)

A collection of functions for handling bitwise flags

## Installation

This library is installed via [Composer](http://getcomposer.org/). To install, use `composer require pointybeard/helpers-functions-flags` or add `"pointybeard/helpers-functions-flags": "~1.0"` to your `composer.json` file.

And run composer to update your dependencies:

    $ curl -s http://getcomposer.org/installer | php

    $ php composer.phar update

### Requirements

There are no particuar requirements for this library other than PHP 5.6 or greater.

To include all the [PHP Helpers](https://github.com/pointybeard/helpers) packages on your project, use `composer require pointybeard/helpers` or add `"pointybeard/helpers": "~1.0"` to your composer file.

## Usage

This library is a collection convenience function for common tasks relating to bitwise flags. They are included by the vendor autoloader automatically. The functions have a namespace of `pointybeard\Helpers\Functions\Flags`

The following functions are provided:

-   `is_flag_set(int $flags, int $flag)`

Example usage:

```php