README

Laranums is a Laravel package that turns PHP enums into a first-class, fully-featured domain primitive. One trait unlocks lookup, conversion, translations, attribute-driven UI metadata, navigation, filtering, comparison, ordering and more.

Installation

composer require lucastuzina/laranums

Quickstart

Drop the Laranum trait into any enum:

use Lucastuzina\Laranums\Laranum;

enum Status: string
{
    use Laranum;

    case Active   = 'active';
    case Inactive = 'inactive';
    case Pending  = 'pending';
}

Status::fromValue('active');             // Status::Active
Status::toSelectOptions();               // ['active' => 'Active', 'inactive' => 'Inactive', …]
Status::Active->next();                  // Status::Inactive
Status::Active->in([Status::Pending]);   // false

Documentation

Full docs live in the docs/ directory:

• Case Attributes — #[Label], #[Color], #[Icon], #[Description] plus label(), color(), icon(), description(), toSelectOptions().
• Trait Methods — Every method the trait adds, organised by concern.
• Utility Enums — Ready-to-use enums (Unit, HttpStatus, Day, Currency, Country, Language, …).
• Laravel Integration — Validation rules, Faker provider, Eloquent query macros.
• Artisan Command — Scaffold new enums with php artisan make:laranum.

Feature Overview

Case Attributes

Attach UI metadata directly to cases — no match statements, no framework lock-in.

use Lucastuzina\Laranums\Attributes\{Label, Color, Icon};

enum OrderStatus: string
{
    use Laranum;

    #[Label('Pending'), Color('yellow'), Icon('clock')]
    case PENDING = 'pending';

    #[Label('Paid'), Color('green'), Icon('check-circle')]
    case PAID = 'paid';
}

OrderStatus::PAID->color();   // 'green'
OrderStatus::toSelectOptions(); // ['pending' => 'Pending', 'paid' => 'Paid']

→ Full details

Method Cheatsheet

→ Full reference

Utility Enums

Ready-to-use, domain-neutral enums that ship with the full Laranum trait baked in.

→ Full details

Laravel Integration

• Validation: OrderStatus::rule(), ::ruleOnly([...]), ::ruleExcept([...]) — returns Laravel's native Enum rule, drop straight into a FormRequest.
• Faker: $faker->enum(OrderStatus::class) via LaranumFakerProvider.
• Eloquent: Order::whereEnum('status', OrderStatus::PAID) and whereEnumNot, orWhereEnum macros — accept enum instances or arrays directly.

→ Full details

Artisan Command

php artisan make:laranum UserRole admin editor guest --type=string --lang=en,de

Scaffolds the enum and optional translation stubs under lang/{locale}/enums.php.

→ Full details

À la carte

If you don't want the whole trait, compose your own from the concerns under Lucastuzina\Laranums\Concerns\*:

use Lucastuzina\Laranums\Concerns\{HasLookup, HasAttributes};

enum MyEnum: string
{
    use HasLookup, HasAttributes;
    // ...
}

License

This package is open-sourced software licensed under the MIT license.