How do I localize enum values in Laravel

Using the BenSampo/laravel-enum Package

The BenSampo/laravel-enum package supports localization of enum descriptions out of the box. Here's how you can use it:

1. Define your enum and implement the `LocalizedEnum` interface:

php
namespace App\Enums;

use BenSampo\Enum\Enum;
use BenSampo\Enum\Contracts\LocalizedEnum;

final class UserRole extends Enum implements LocalizedEnum
{
    const Administrator = 0;
    const Moderator = 1;
    const Subscriber = 2;
}

2. Add the translations to your language files (e.g., `resources/lang/en/enums.php`):

php
return [
    UserRole::class => [
        UserRole::Administrator => 'Administrator',
        UserRole::Moderator => 'Moderator',
        UserRole::Subscriber => 'Subscriber',
    ],
];

3. Now you can use the `description` property to get the localized value:

php
$role = UserRole::Moderator;
echo $role->description; // Output: "Moderator"

Using a Custom Trait

If you're not using the BenSampo package, you can create a custom trait to handle localization of enum values:

php
namespace App\Enums\Concerns;

trait Translatable
{
    public function getLabel(): string
    {
        $key = sprintf('%s.%s', static::class, $this->value);
        return __($key);
    }
}

Then, in your enum class, use the `Translatable` trait:

php
namespace App\Enums;

use App\Enums\Concerns\Translatable;

enum UserRole: string
{
    use Translatable;

    case Administrator = 'administrator';
    case Moderator = 'moderator';
    case Subscriber = 'subscriber';
}

And add the translations to your language files (e.g., `resources/lang/en/enums.php`):

php
return [
    'App\Enums\UserRole' => [
        'administrator' => 'Administrator',
        'moderator' => 'Moderator',
        'subscriber' => 'Subscriber',
    ],
];

Now you can use the `getLabel()` method to get the localized value:

php
$role = UserRole::Moderator;
echo $role->getLabel(); // Output: "Moderator"

Using a Custom Enum Class

Another approach is to create a custom Enum class that handles localization:

php
namespace App\Enums;

use BenSampo\Enum\Enum;
use Illuminate\Support\Facades\Lang;

abstract class LocalizedEnum extends Enum
{
    public function getDescription(): string
    {
        $key = $this->getTranslationKey();
        return Lang::get($key);
    }

    protected function getTranslationKey(): string
    {
        return sprintf('enums.%s.%s', static::class, $this->value);
    }
}

// Usage
final class UserRole extends LocalizedEnum
{
    const Administrator = 'administrator';
    const Moderator = 'moderator';
    const Subscriber = 'subscriber';
}

And add the translations to your language files (e.g., `resources/lang/en/enums.php`):

php
return [
    'App\Enums\UserRole' => [
        'administrator' => 'Administrator',
        'moderator' => 'Moderator',
        'subscriber' => 'Subscriber',
    ],
];

Now you can use the `getDescription()` method to get the localized value:

php
$role = UserRole::Moderator;
echo $role->getDescription(); // Output: "Moderator"

The key benefits of these approaches are:

1. Consistency: Providing a consistent way to localize enum values across your application.
2. Flexibility: Allowing you to customize the localization logic to fit your specific needs.
3. Maintainability: Centralizing the localization logic in one place, making it easier to update and manage.

Choose the approach that best fits your project's requirements and coding style.