README

Elegant and lightweight helpers for PHP enums. Adds only(), except(), onlyList(), exceptList(), automatic validation, and custom exceptions — to make working with PHP 8.1+ enums clean and easy.

Installation

description: Install this package via Composer:

composer require sezer/enum-helpers

Usage:

Add the EnumTrait to your enum and use the methods:

use Sezer\EnumHelpers\Traits\EnumTrait;

enum OrderStatus: string {
    use EnumTrait;

  case PENDING  = 'pending';
  case APPROVED = 'approved';
  case REJECTED = 'rejected';
  case COMPLETE = 'complete';
  case RETURNED = 'returned';
}

Examples:

• Filter with only() Keep only specified cases.

  $result = OrderStatus::only(['PENDING', 'APPROVED']);
  print_r($result);
  output:
      [
      'PENDING'  => OrderStatus::PENDING,
      'APPROVED' => OrderStatus::APPROVED
      ]

• Exclude with except() Exclude specified cases.

  $result = OrderStatus::except(['REJECTED']);
  print_r($result);
  output:
  [
  'PENDING'  => OrderStatus::PENDING,
  'APPROVED' => OrderStatus::APPROVED
  ]

• 📜 Get just the values as plain array onlyList();

  OrderStatusEnum::onlyList(['PENDING', 'APPROVED']);
  
    output: ['pending', 'approved']

• exceptList()

OrderStatusEnum::exceptList(['COMPLETE']);
output: ['pending', 'approved', 'rejected', 'returned']

🎯 With Laravel

✨ If your model has Enum cast:

protected $casts = [
    'order_status' => OrderStatusEnum::class,
];

You can pass Enum cases directly in queries:

Order::whereIn(
    'order_status',
    OrderStatusEnum::except(['COMPLETE'])
)->get();

<select name="status">
@foreach (OrderStatusEnum::except(['COMPLETE']) as $key => $status)
    <option value="{{ $status->value }}">{{ ucfirst(strtolower($key)) }}</option>
@endforeach
</select>

In Validation:

use Illuminate\Validation\Rule;

$request->validate([
    'status' => [
        'required',
        Rule::in(OrderStatusEnum::exceptList(['COMPLETE']))
    ]
]);

✨ If your model does NOT have Enum cast:

You need the ->value of each case:

Order::whereIn(
    'order_status',
    OrderStatusEnum::exceptList(['COMPLETE'])
)->get();

In Blade:

<select name="status">
@foreach (OrderStatusEnum::exceptList(['COMPLETE']) as $status)
    <option value="{{ $status }}">{{ ucfirst($status) }}</option>
@endforeach
</select>

In Validation:

$request->validate([
    'status' => [
        'required',
        Rule::in(OrderStatusEnum::exceptList(['COMPLETE']))
    ]
]);

Errors:

Invalid keys

If you pass an invalid case name to only() or except(), an InvalidEnumKeyException is thrown. example: OrderStatus::only(['INVALID']); Sezer\EnumHelpers\Exceptions\InvalidEnumKeyException: Invalid enum key: INVALID

Test

 vendor/bin/phpunit 

Authors

@sezer

🔗 Links

Support

For support, email hussiensezer@gmail.com