Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henrywhitaker3/bitmasked-properties
https://github.com/henrywhitaker3/bitmasked-properties
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/henrywhitaker3/bitmasked-properties
- Owner: henrywhitaker3
- License: mit
- Created: 2021-11-23T02:16:17.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-08T12:33:44.000Z (almost 3 years ago)
- Last Synced: 2024-05-28T14:11:58.136Z (7 months ago)
- Language: PHP
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bitmasked Properties
This library provides a trait to use bitmasked properties with PHP 8.1 enums. I was reading [this](https://aaronfrancis.com/2021/bitmasking-in-laravel-and-mysql) and could think a few different places where this would be useful for me, so I decided to make this library to make it a bit more re-usable; it also felt like a good way to start playing around with PHP 8.1 enums.
## Installation
```shell
composer require henrywhitaker3/bitmasked-properties
```
## Usage
For example, you have a model `Person` that can be opted in or out for email and sms comms. A simple (not v good) way of doing this could be having individual columns in the database to store each of these methods:
```php
class Person
{
public function __construct(
public bool $sms,
public bool $email
) {}
public function isOptedIn(string $type): bool
{
// Should really check the value of type is valid first...
return $this->{$type};
}
public function optin(string $type): void
{
$this->updateOptin($type, true);
}
public function optout(string $type): void
{
$this->updateOptin($type, false);
}
private function updateOptin(string $type, bool $value): void
{
switch($type) {
case 'sms':
$this->sms = $value;
break;
case 'email':
$this->email = $value;
break;
}
}
}
```
This requires hard-coding the field names and having to run migrations to add columns when a new communication type comes along, which is a bit gross.
For some scenarios, using a bitmasked field would be a far nicer solution - only some as you can't index these values and therefore can't query them very efficiently. But, it allows you to just add a new case to the enum whenever a new communication type gets added with no change to the database. Using this you can have up to 32 different boolean values in a standard integer field. Here's how to use it for the person example above:
```php
enum Optin: int implements BitmaskEnum
{
case SMS = 1 << 0; // 1
case EMAIL = 1 << 1; // 2
}
```
```php
class Person
{
use HasBitmaskedProperties;
public function __construct(
public bool $optin
) {}
public function isOptedIn(Optin $type): bool
{
return $this->getFlag('optin', $type);
}
public function optin(Optin $type): void
{
$this->setFlag('optin', $type, true);
}
public function optout(Optin $type): void
{
$this->setFlag('optin', $type, false);
}
public function getOptins(): WeakMap
{
return $this->flagToWeakmap('optin', Optin::class);
}
}
```
Now it's really simple to use:
```php
$person = new Person; // $optin === 0
$person->isOptedIn(Optin::SMS); // returns false
$person->optin(Optin::SMS); // $optin === 1
$person->isOptedIn(Optin::SMS); // returns true
$person->optin(Optin::EMAIL); // $optin === 3
$person->isOptedIn(Optin::EMAIL); // returns true
$person->optout(Optin::SMS); // $optin === 2
$person->isOptedIn(Optin::SMS); // returns false
$person->getOptins()[Optin::EMAIL]; // return true
```
You can add a new value to the `Optin` enum with no changes to the database or code.