Code Monkey home page Code Monkey logo

laravel-enum-translations's Introduction

Simple Enum translations for Laravel

a Laravel package that simplifies the translation of enums in your applications, making it easy to associate enum values with translated labels for multiple languages. It enhances code readability and maintainability by handling enum translations seamlessly.

This makes it super easy to provide your front-end with a list of enum-keys with corresponding labels.

Features

  • Automatically load translated labels for your application Enums
  • Provide a fallback based on the enum key to easily find missing translations
  • Follows the configured locale of your application

Getting started

  1. Use composer to install the package composer require ifresh/laravel-enum-translations
  2. Publish the configuration files ./artisan vendor:publish --tag=laravel-enum-translations
  3. Modify the lang/en/enums.php file OR copy this file to your application's locale folder.

Example

Given the following enum:

namespace App\Enums;

enum Cards: string
{
    case Hearts = 'hearts';
    case Diamonds = 'diamonds';
    case Clubs = 'clubs';
    case Spades = 'spades';
}

You can add translated values by modifying the lang/en/enums.php file:

return [
    'cards' => [
        'hearts' => 'Hearts ❤️',
        'diamonds' => 'Diamonds 💎',
        'clubs' => 'Clubs ♣️',
        'spades' => 'Spades ♠️',
    ],
];

Now to use these translations in your application by using the EnumTranslatorFacade:

If you simply want to get the list of all the translations for a single Enum (for instance when filling a dropdown) you can use the translate method available on the Facade:

use App\Enums\Cards;
use IFresh\EnumTranslations\EnumTranslatorFacade as EnumTranslator;

$translations = EnumTranslator::translate(Cards::class);
/*
 * [
 *   'hearts' => 'Hearts ❤️',
 *   'diamonds' => 'Diamonds 💎',
 *   'clubs' => 'Clubs ♣️',
 *   'spades' => 'Spades ♠️',
 * ]
 */

It is also possible to get the translated value for a single enum value, to do this you can use the translateValue method instead:

EnumTranslator::translateValue(Cards::class, Cards::Hearts); // 'Hearts ❤️'

When you pass null as the selected enum value, an empty string is returned:

EnumTranslator::translateValue(Cards::class, null); // '' 

Contributing

All contributions are welcome! Please open a GitHub Issue or create a Pull-request

License

The Laravel enum translations package is free software released under the MIT License. See LICENSE.txt for details.

laravel-enum-translations's People

Contributors

tkuijer avatar pvdptje avatar

Stargazers

Tommi Carleman avatar

Watchers

 avatar

Forkers

infyrazer pvdptje

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.