README

Larnums Package provides useful methods nearly every Laravel application that uses enums needs.

Installation

composer require lucastuzina/laranums

Usage

To use the Package simple import the trait on your enum:

use Lucastuzina\Laranums\Laranum;

enum SomeEnum
{
    use Laranum;

    case FIRST_CASE;
    case SECOND_CASE;
}

Generating Enums with Artisan

Laranums provides a convenient Artisan command to generate enums with the Laranum trait automatically. This command creates an enum file in the app/Enums directory.

Usage:

php artisan make:laranum EnumName [backedType] caseOne caseTwo caseThree

Example:

php artisan make:laranum UserRole string ADMIN EDITOR GUEST

This will generate the following enum file:

<?php

namespace App\Enums;

use Lucastuzina\Laranums\Laranum;

enum UserRole: string
{
    use Laranum;

    case ADMIN = 'admin';
    case EDITOR = 'editor';
    case GUEST = 'guest';
}

The command ensures that your enums are structured correctly and automatically includes the Laranum trait, giving you access to all the useful utility methods provided by the package.

Utility Enums

Laranums now includes ready-to-use utility enums for common use cases:

Unit Enum

The Unit enum provides various units of measurement with built-in conversion functionality:

use Lucastuzina\Laranums\Enums\Unit;

// Available units include:
// Length: CENTIMETER, METER, KILOMETER, INCH, FOOT, YARD, MILE
// Weight: GRAM, KILOGRAM, TON, OUNCE, POUND
// Time: SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS
// Speed: KILOMETERS_PER_HOUR, MILES_PER_HOUR, METERS_PER_SECOND, FEET_PER_SECOND
// Temperature: CELSIUS, FAHRENHEIT, KELVIN
// Other: PERCENTAGE, BEATS_PER_MINUTE, COUNT, ML_PER_KG_MIN, NEWTON, JOULE, WATT, KILOWATT

// Usage examples:
$meters = Unit::METER;
echo $meters->value; // 'm'

// Unit conversion
$result = Unit::convert(100, Unit::CENTIMETER, Unit::METER); // 1.0
$result = Unit::convert(32, Unit::FAHRENHEIT, Unit::CELSIUS); // 0.0
$result = Unit::convert(1, Unit::KILOMETER, Unit::METER); // 1000.0

// Also includes all Laranum trait methods
$allUnits = Unit::cases();
$randomUnit = Unit::rand();
$unitFromValue = Unit::fromValue('km'); // Unit::KILOMETER

Utility Methods

Laranums provides various helper methods to make working with enums easier:

fromName(string $name): ?self – Get an enum case by name.
fromValue($value): ?self – Get an enum case by value (for backed enums).
fromNameOrDefault(string $name, self $default): self – Get an enum case by name, or return a default.
fromValueOrDefault($value, self $default): self – Get an enum case by value, or return a default.
className(): string – Get the enum class name.
toArray(): array – Get an associative array of [value => name].
toArrayReversed(): array – Get an associative array of [name => value].
names(): array – Get an array of all case names.
values(): array – Get an array of all case values.
transNames(): array – Get translated names [name => translation].
transValues(): array – Get translated values [value => translation].
trans(string $caseName): string – Get a translated string for a specific case.
rand(array $ignoredCases = []): ?self – Get a random case, optionally ignoring some.
isValidName($name): bool – Check if a given name exists in the enum.
isValidValue($value): bool – Check if a given value exists in the enum.
collect(): Collection – Get a Laravel collection of all cases.
jsonSerialize(): array – Serialize the enum for JSON output.

License

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

lucastuzina / laranums

Maintainers

Details