https://github.com/tailflow/enum
PHP Enums
https://github.com/tailflow/enum
Last synced: 2 months ago
JSON representation
PHP Enums
- Host: GitHub
- URL: https://github.com/tailflow/enum
- Owner: tailflow
- Created: 2020-11-01T07:33:45.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-24T13:48:11.000Z (over 4 years ago)
- Last Synced: 2025-03-27T18:22:19.379Z (3 months ago)
- Language: PHP
- Size: 12.7 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Introduction
The package offers strongly typed enums in PHP. In this package, enums are always objects, never constant values on their own. This allows for proper static analysis and refactoring in IDEs.
## Installation
You can install the package via composer:
```bash
composer require tailflow/enum
```
## Usage
Here is how enums are defined:
```php
use Tailflow\Enum\Enum;
class Status extends Enum
{
public const Inactive = 0;
public const Active = 1;
public const OnHold = 3;
}
```
This is how they are used:
```php
$class->setStatus(Status::Inactive);
```
### Custom enum labels
By default, enum labels are derived from the constant names. To get enum label, you can use `::getLabel` method on enum class:
```php
// $label will be equal to "OnHold" - the name of the constant
$label = Status::getLabel(Status::OnHold);
```
Optionally, you can provide a different label for any given enum value:
```php
use Tailflow\Enum\Enum;
class Status extends Enum
{
public const Inactive = 0;
public const Active = 1;
public const OnHold = 3;
public static function labels(): array
{
return [
self::OnHold => 'waiting'
];
}
}
// $label will be equal to "waiting" - the custom label defined in "labels" method
$label = Status::getLabel(Status::OnHold);
```
## Listing all enum labels
To get a list of all labels of the enum, you can use `::getLabels` method:
```php
// $labels will contain the array - ['Inactive', 'Active', 'waiting']
$labels = Status::getLabels();
```
## Listing all enum values
To get a list of all values of the enum, you can use `::getValues` method:
```php
// $labels will contain the array - [0, 1, 3]
$labels = Status::getValues();
```
## License
The Laravel Orion is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).