chinleung/laravel-locales

Add configurations and helpers for a multi locale application.

v1.2.2 2021-02-22 18:39 UTC

This package is auto-updated.

Last update: 2021-09-22 19:59:21 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

Add configurations and helpers to make an application support multiple locales.

Installation

You can install the package via composer:

composer require chinleung/laravel-locales

Configuration

By default, the application locales is only going to be en. If your application support other locales, you can either set a app.locales in your config/app.php or publish the configuration file:

php artisan vendor:publish --provider="ChinLeung\LaravelLocales\LaravelLocalesServiceProvider" --tag="config"

Helpers

locale(string $locale = null) : string

Retrieve or update the current locale of the application.

// Alias of app()->getLocale();
locale(); // 'en'

// Alias of app()->setLocale('fr');
locale('fr'); // 'fr'
locale(); // 'fr'

locales(array $locales = null) : array

Retrieve or update the supported locales of the application.
Has priority for app.locales over laravel-locales.supported.

locales(); // ['en']

locales(['en', 'fr', 'zh']);
locales(); // ['en', 'fr', 'zh']

locales(['en', 'zh']);
locales(); // ['en', 'zh']

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email hello@chinleung.com instead of using the issue tracker.

Credits

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.