rickgoemans/laravel-enum-helpers

A Laravel helper to have nice enum related functions

v3.0.0 2024-03-13 07:59 UTC

Requires

• php: ^8.2
• illuminate/contracts: ^11.0
• spatie/laravel-package-tools: ^1.14.0

Requires (Dev)

• larastan/larastan: ^2.8
• laravel/pint: ^1.13
• nunomaduro/collision: ^8.1
• orchestra/testbench: ^9.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.5
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0

MIT

• Rick Goemans

• laravel
• rickgoemans
• laravel-enum-helpers

README

A Laravel helper to have nice enum related functions

This package contains some useful helpers for Laravel and PHP's enums.

Installation

You can install the package via composer:

composer require rickgoemans/laravel-enum-helpers

Usage

Example enum:

<?php

namespace Rickgoemans\LaravelEnumHelpers\Enums;

use Rickgoemans\LaravelEnumHelpers\Traits\HasEnumHelpers;

enum CreditCheckRating: string
{
    use HasEnumHelpers;

    case AAA = 'AAA';
    case AA = 'AA';
    case A = 'A';
    case BBB = 'BBB';
    case BB = 'BB';
    case B = 'B';
    case CCC = 'CCC';
    case CC = 'CC';
    case C = 'C';
    case D = 'D';

    /** @inheritdoc */
    public static function badgeColors(): array
    {
        return [
            self::AAA->label() => 'success',
            self::AA->label()  => 'success',
            self::A->label()   => 'success',
            self::BBB->label() => 'info',
            self::BB->label()  => 'info',
            self::B->label()   => 'info',
            self::CCC->label() => 'info',
            self::CC->label()  => 'info',
            self::C->label()   => 'info',
            self::D->label()   => 'danger',
            self::NR->label()  => 'danger',
            null               => 'danger',
        ];
    }

    /** @inheritdoc */
    public static function order(): array
    {
        return [
            self::AAA,
            self::AA,
            self::A,
            self::BBB,
            self::BB,
            self::B,
            self::CCC,
            self::CC,
            self::C,
            self::D,
            self::NR,
        ];
    }
    
    /** @inheritdoc */
    public function label(): string
    {
        return $this->baseLabel('credit_checks.rating.values.');
    }
}

Example Laravel Nova resource with badge and select fields usage:

<?php

namespace App\Nova;

use Laravel\Nova\Fields\Badge;
use Laravel\Nova\Resource;
use Rickgoemans\LaravelEnumHelpers\Enums\CreditCheckRating;

class CreditCheck extends Resource {
    // ...
    
    public function fields(Request $request): array {
        return [
            // ...
            
            Badge::make(__('credit_checks.rating.label'), 'rating', fn(CreditCheckRating $rating) => $rating->label())
                ->map(CreditCheckRating::badgeColors())
                ->sortable(),
                
            Select::make(__('credit_checks.rating.label'), 'rating')
                ->options(CreditCheckRating::optionsForSelect())
                ->onlyOnForms(),
                
            // ...
        ];       
    }
    
    // ...
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Rick Goemans

License

The MIT License (MIT). Please see License File for more information.