Translatable Enums

Last updated on by

Translatable Enums image

Enums are a great addition to PHP and Laravel. They are very helpful with code maintainability and clarity. If you are building multilingual applications, you may need to translate those Enum values as well. This is where the Laravel Enum Translatable package, created by Osama Sadah, comes in.

Main Features

  • Translation Support: Automatically translate enum values using Laravel's translation system
  • Array Conversion: Convert enums to arrays with value and name for easy API responses
  • Object Method: Get enum as an object with value and translated name
  • Multiple Locales: Support for multiple locales with the trans() and allTrans() methods
  • Easy Integration: Simple trait-based implementation
  • Modular Support: Optional support for modular Laravel applications

Example

Ensure you add the EnumTranslatable trait to your Enum class.

namespace App\Enums\Article;
 
use Osama\LaravelEnums\Concerns\EnumTranslatable;
 
enum ArticleStatus: string
{
use EnumTranslatable;
 
case DRAFT = 'draft';
case PUBLISHED = 'published';
case REJECTED = 'rejected';
}

Now you can create translation files in the lang directory of your Laravel application. The translation key is automatically generated based on the enum class name.

For example, in lang/en/enums.php, you could have:

return [
'article_statuses' => [
'draft' => 'Draft',
'published' => 'Published',
'rejected' => 'Rejected',
],
];

And in lang/es/enums.php, you could have:

return [
'article_statuses' => [
'draft' => 'Borrador',
'published' => 'Publicado',
'rejected' => 'Rechazado',
],
];

To get the translated value of an Enum, use the trans() or transAll() method:

$status = ArticleStatus::DRAFT;
 
// Get translation in current locale
$translated = $status->trans();
 
// Get translation in specific locale
$english = $status->trans('en'); // Outputs: Draft
$spanish = $status->trans('es'); // Outputs: Borrador
 
// or All translations
$allTranslations = $status->allTrans(); // Outputs: ['en' => 'Draft', 'es' => 'Borrador']

The package also allows you to automatically cast translatable enums in your Eloquent models:

namespace App\Models;
 
use App\Enums\Article\ArticleStatus;
use Illuminate\Database\Eloquent\Model;
 
class Article extends Model
{
//...
 
protected function casts(): array
{
return [
'status' => ArticleStatus::class,
];
}
}

Learn more about this package and view the source code on GitHub.

Also check out

Yannick Lyn Fatt photo

Staff Writer at Laravel News and Full stack web developer.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
SerpApi

The Web Search API for Your LLM and AI Applications

Visit SerpApi
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $9500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Laravel Cloud logo

Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Cloud
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing
PhpStorm logo

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Acquaint Softtech logo

Acquaint Softtech

Acquaint Softtech offers AI-ready Laravel developers who onboard in 48 hours at $3000/Month with no lengthy sales process and a 100 percent money-back guarantee.

Acquaint Softtech

The latest

View all →
Route Metadata Support in Laravel 13.17 image

Route Metadata Support in Laravel 13.17

Read article
Ship AI with Laravel: Failover, Queues, and Middleware for AI Agents image

Ship AI with Laravel: Failover, Queues, and Middleware for AI Agents

Read article
Monitor and Control Schedules, Queues, and Errors in Laravel with Watchtower image

Monitor and Control Schedules, Queues, and Errors in Laravel with Watchtower

Read article
Showcase Your PhpStorm Expertise on LinkedIn image

Showcase Your PhpStorm Expertise on LinkedIn

Read article
Privacy Filter: Detect PII in Text from Laravel image

Privacy Filter: Detect PII in Text from Laravel

Read article
NationForge: A Self-Hosted Admin Panel for Civic Organizations image

NationForge: A Self-Hosted Admin Panel for Civic Organizations

Read article