README

Easy to use internationalization functions for Laravel 5 and Lumen based on various libraries for easy retrieval of localized values and formatting of numeric values into their localized patterns.

Overview

• Installation
• Usage
  • Country
  • Currency
  • Date
  • Language
  • Number
• Changing locales

Installation

Run the following command to install the latest version of the package

composer require propaganistas/laravel-intl

Laravel

In your app config, add the Service Provider to the $providers array

'providers' => [
   ...
   Propaganistas\LaravelIntl\IntlServiceProvider::class,
],

Lumen

In bootstrap/app.php, register the Service Provider

$app->register(Propaganistas\LaravelIntl\IntlServiceProvider::class);

Usage

Note: always use the helper functions or Facades, or make use of dependency injection.

Country

Output localized country names.

use Propaganistas\LaravelIntl\Facades\Country;

// Application locale: nl
Country::name('US'); // Verenigde Staten
Country::all(); // ['US' => 'Verenigde Staten', 'BE' => 'België', ...]

// Application locale: en
country('US'); // United States
country()->all(); // ['US' => 'United States', 'BE' => 'Belgium', ...]

Currency

Output localized currency names and format currency amounts into their localized pattern.

use Propaganistas\LaravelIntl\Facades\Currency;

// Application locale: nl
Currency::name('USD'); // Amerikaanse dollar
Currency::symbol('USD'); // $
Currency::format(1000, 'USD'); // $ 1.000,00
Currency::formatAccounting(-1234, 'USD'); // (US$ 1.234,00)
Currency::all(); // ['USD' => 'Amerikaanse dollar', 'EUR' => 'Euro', ...]

// Application locale: en
currency('USD'); // US Dollar
currency()->symbol('USD'); // $
currency(1000, 'USD'); // $1,000.00
currency()->all(); // ['USD' => 'US Dollar', 'EUR' => 'Euro', ...]

Parse localized values into native PHP numbers.

use Propaganistas\LaravelIntl\Facades\Currency;

// Application locale: nl
Currency::parse('€ 1.234,50'); // 1234.5

// Application locale: nl
currency()->parse('€ 1.234,50'); // 1234.5

Date

Output localized dates.

Use the Facade (Propaganistas\LaravelIntl\Facades\Carbon) or the helper function (carbon()) as if it were Carbon. Everything will be localized automatically.

Additional methods are also available to output dates in their localized format. E.g. toShortDateString():

• Locale "en": 1/31/2018
• Locale "nl": 31-01-2018

use Propaganistas\LaravelIntl\Facades\Carbon;

$date = Carbon::now(); // or carbon()->now()

$date->toShortDateString();
$date->toMediumDateString();
$date->toLongDateString();
$date->toFullDateString();

$date->toShortTimeString();
$date->toMediumTimeString();
$date->toLongTimeString();
$date->toFullTimeString();

$date->toShortDatetimeString();
$date->toMediumDatetimeString();
$date->toLongDatetimeString();
$date->toFullDatetimeString();

Language

Output localized language names.

use Propaganistas\LaravelIntl\Facades\Language;

// Application locale: nl
Language::name('en'); // Engels
Language::all(); // ['en' => 'Engels', 'nl' => 'Nederlands', ...]

// Application locale: en
language('en'); // English
language()->all(); // ['en' => 'English', 'nl' => 'Dutch', ...]

Number

Output localized numeric values into their localized pattern.

use Propaganistas\LaravelIntl\Facades\Number;

// Application locale: en
Number::format(1000); // '1,000'
Number::percent('0.75'); // '75%'

// Application locale: fr
number(1000); // '1 000'
number()->percent('0.75'); // '75 %'

Parse localized values into native PHP numbers.

use Propaganistas\LaravelIntl\Facades\Number;

// Application locale: fr
Number::parse('1 000'); // 1000
number()->parse('1,5'); // 1.5

Changing locales

Ever feel the need to use a locale other than the current application locale? You can temporarily use another locale by using the usingLocale() method.

country()->name('US'); // United States

country()->usingLocale('nl', function($country) {
    return $country->name('US');
}); // Verenigde Staten

country()->name('US'); // United States

Alternatively, you can force each component individually to the preferred locale for the remainder of the application by calling the setLocale() on the helper function or Facade. Usually you'd set this in the boot() method of a ServiceProvider.