README

# Status Enum Package

A lightweight, reusable PHP 8.1+ package that standardizes enum usage for dropdowns, validation, and display logic—especially useful in Laravel applications.
some changes may apply
---

## ✨ Features

- Enum value extraction for validation
- Dropdown-friendly options
- Clean label formatting
- Built-in validation rule
- Instance helper methods (`is`, `label`)
- Laravel-ready (framework-agnostic core)

---

## 📥 Installation

```bash
composer require roshan-dhungana/status

⚙️ Requirements

• PHP 8.1+
• Laravel 10+ (optional)

🚀 Quick Start

Create your Enum

namespace App\Enums;

use RoshanDhungana\Status\Contracts\EnumContract;
use RoshanDhungana\Status\Traits\HasEnumHelpers;

enum ProjectStatus: string implements EnumContract
{
    use HasEnumHelpers;

    case ACTIVE = 'active';
    case INACTIVE = 'inactive';
    case DRAFT = 'draft';
}

📋 Usage

Get values (for validation)

ProjectStatus::values();

Returns:

['active', 'inactive', 'draft']

Validation (Laravel)

use Illuminate\Validation\Rule;

'status' => ProjectStatus::rule(),

Dropdown options

ProjectStatus::options();

Returns:

[
    'active' => 'Active',
    'inactive' => 'Inactive',
    'draft' => 'Draft',
]

Blade Example

@foreach(ProjectStatus::options() as $value => $label)
    <option value="{{ $value }}">{{ $label }}</option>
@endforeach

Get label from enum instance

$status->label();

Compare values safely

if ($status->is(ProjectStatus::ACTIVE)) {
    // logic here
}

or

$status->is('active');

Parse from raw value

$status = ProjectStatus::fromValue('active');

🧠 Why Use This Package?

Without this package, enum usage is often scattered:

• Hardcoded arrays in validation
• Duplicate dropdown mappings
• Inconsistent label formatting

This package centralizes everything into a single source of truth, improving:

• Maintainability
• Readability
• Consistency across your app

🏗 Architecture

• Contracts → define behavior
• Traits → reusable enum logic
• Enums → domain-specific states

The core is framework-agnostic while supporting Laravel seamlessly.

📌 Example: Eloquent Casting (Laravel)

protected $casts = [
    'status' => ProjectStatus::class,
];

🔧 Extending

Create additional enums easily:

enum OrderStatus: string implements EnumContract
{
    use HasEnumHelpers;

    case PENDING = 'pending';
    case COMPLETED = 'completed';
}

🤝 Contributing

Contributions, issues, and feature requests are welcome.