Laravel Lang

https://laravel-lang.com
Admin
Laravel Lang is a localization package that simplifies managing translations and locales in Laravel...
Tokens:27,071
Snippets:448
Trust Score:7.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### URL Parameter Localization Example

Source: https://laravel-lang.com/packages-routes.html

Demonstrates localization by appending the language code as a URL parameter. If an incorrect or unset localization is submitted, the page will render according to the main localization installed in the application.

```bash
curl -XGET https://example.com/some/show/bar/de
```

```json
{
    "show": "Alle Ressourcen geladen."
}
```

```bash
curl -XGET https://example.com/some/show/bar/as
```

```http
### 302 Redirect
Location: https://example.com/foo/fr/show
```

```bash
curl -XGET https://example.com/some/show/bar/qwerty
```

```http
### 302 Redirect
Location: https://example.com/foo/fr/show
```

```bash
curl -XGET https://example.com/some/show/bar/
```

```http
### 302 Redirect
Location: https://example.com/foo/fr/show
```

--------------------------------

### Production Installation

Source: https://laravel-lang.com/upgrade-publisher-to-15-from-14.html

Commands to install the laravel-lang/publisher and laravel-lang/locales packages for production use.

```bash
composer require laravel-lang/publisher --dev --quiet
composer require laravel-lang/locales
```

--------------------------------

### Install Native Currency Names Package

Source: https://laravel-lang.com/packages-native-currency-names.html

Install the package using Composer.

```bash
composer require laravel-lang/native-currency-names
```

--------------------------------

### Install laravel-lang/native-country-names

Source: https://laravel-lang.com/packages-native-country-names.html

Run this command to install the package via Composer.

```bash
composer require laravel-lang/native-country-names
```

--------------------------------

### Install Native Locale Names Package

Source: https://laravel-lang.com/packages-native-locale-names.html

Install the package using Composer.

```bash
composer require laravel-lang/native-locale-names
```

--------------------------------

### Install laravel-lang/actions

Source: https://laravel-lang.com/packages-actions.html

Install the package as a development dependency using Composer.

```bash
composer require --dev laravel-lang/actions
```

--------------------------------

### Aliases Configuration Example (Commented)

Source: https://laravel-lang.com/configuration.html

An example of how to configure aliases in `config/localization.php`, with commented-out entries.

```php
return [
    'aliases' => [
        // \LaravelLang\LocaleList\Locale::German->value => 'de-DE',
        // \LaravelLang\LocaleList\Locale::GermanSwitzerland->value => 'de-CH',
    ],
];
```

--------------------------------

### Installation

Source: https://laravel-lang.com/packages-locales.html

Instructions on how to install the Laravel Lang Locales package using Composer.

```APIDOC
## Installation

To install, run the console command:
```
composer require laravel-lang/locales
```
```

--------------------------------

### Install Laravel Lang Models

Source: https://laravel-lang.com/packages-models.html

Run this composer command to install the package. Ensure you have composer installed and configured.

```bash
composer require laravel-lang/models
```

--------------------------------

### Update Facade Helper Usage

Source: https://laravel-lang.com/upgrade-publisher-to-15-from-14.html

Demonstrates the change in how to access locale information using the facade helper before and after the update. The 'After' example shows how to get raw locale data.

```php
// Before
use LaravelLang\Publisher\Facades\Helpers\Locales;

return Locales::available(); // array<string>
// ['en', 'fr', 'de', ...]

return Locales::getDefault(); // string
// de-DE
```

```php
// After
use LaravelLang\Publisher\Facades\Helpers\Locales;

return Locales::available(); // array<LocaleData>
// [<object>, <object>, ...]

return Locales::getDefault(); // LocaleData
// <object>

return Locales::raw()->available(); // array<string>
// ['en', 'fr', 'de', ...]

return Locales::raw()->getDefault(); // string
// de-DE
```

--------------------------------

### Install Laravel Lang Locales

Source: https://laravel-lang.com/packages-locales.html

Run this command in your console to install the package.

```bash
composer require laravel-lang/locales
```

--------------------------------

### Production Installation (No Locales)

Source: https://laravel-lang.com/upgrade-publisher-to-15-from-14.html

Command to install the laravel-lang/publisher package as a development dependency if locales are not used in production.

```bash
composer require laravel-lang/publisher --dev --quiet
```

--------------------------------

### Install laravel-lang/starter-kits

Source: https://laravel-lang.com/packages-starter-kits.html

Install the starter kits localization package using Composer. This command should be run in your project's root directory.

```bash
composer require --dev laravel-lang/starter-kits
```

--------------------------------

### Install JSON Fallback Package

Source: https://laravel-lang.com/packages-json-fallback.html

Run this command to install the laravel-lang/json-fallback package using Composer.

```bash
composer require laravel-lang/json-fallback
```

--------------------------------

### Install Laravel Lang Publisher

Source: https://laravel-lang.com/packages-publisher.html

Install the package as a development dependency using Composer.

```bash
composer require --dev laravel-lang/publisher
```

--------------------------------

### Install laravel-lang/http-statuses Package

Source: https://laravel-lang.com/packages-http-statuses.html

Install the package using Composer. This is a development dependency.

```bash
composer require --dev laravel-lang/http-statuses
```

--------------------------------

### Default Language File Example

Source: https://laravel-lang.com/configuration.html

This is an example of a default language file, showing the standard format for translation lines.

```php
declare(strict_types=1);

return [
    /*
    |--------------------------------------------------------------------------
    | Authentication Language Lines
    |--------------------------------------------------------------------------
    |
    | The following language lines are used during authentication for various
    | messages that we need to display to the user. You are free to modify
    | these language lines according to your application's requirements.
    |
    */
    'failed'   => 'These credentials do not match our records 123456.',
    'throttle' => 'Too many login attempts. Please try again in :seconds seconds.',
    'foo'      => 'bar',
];
```

--------------------------------

### Example Response for Localized Route (French)

Source: https://laravel-lang.com/basic-usage.html

Example JSON response for the French locale of the `/foo/show` route.

```json
{
    "show": "Toutes les données ont été chargées."
}
```

--------------------------------

### Install laravel-lang/lang

Source: https://laravel-lang.com/packages-lang.html

Install the package using Composer. This command adds the package as a development dependency.

```bash
composer require --dev laravel-lang/lang
```

--------------------------------

### Example Request for Localized Route

Source: https://laravel-lang.com/basic-usage.html

Example cURL request to a localized route (`/fr/foo/show`).

```bash
curl -XGET https://example.com/fr/foo/show
```

--------------------------------

### Install laravel-lang/moonshine Package

Source: https://laravel-lang.com/packages-moonshine.html

Run this command in your terminal to install the package as a development dependency.

```bash
composer require --dev laravel-lang/moonshine
```

--------------------------------

### Example Response for German Localized Route

Source: https://laravel-lang.com/basic-usage.html

Example JSON response for the German locale of the `/foo/show` route.

```json
{
    "show": "Alle Ressourcen geladen."
}
```

--------------------------------

### Inline vs Default Translation Example

Source: https://laravel-lang.com/configuration.html

Illustrates the difference between default and inline translation strings for the same key.

```text
The :attribute must be accepted. // default
This field must be accepted. // inline
```

--------------------------------

### Smart Punctuation Example (Before)

Source: https://laravel-lang.com/configuration.html

Example of JSON content with standard ASCII punctuation that will be converted by the smart punctuation feature.

```json
{
    "Some": "\"It's super-configurable... you can even use additional extensions to expand its capabilities -- just like this one!\""
}
```

--------------------------------

### Validation Language File Example

Source: https://laravel-lang.com/configuration.html

An example of a `validation.php` file, demonstrating various validation error messages and custom attributes.

```php
declare(strict_types=1);

return [
    'accepted'   => 'The :attribute must be accepted.',
    'active_url' => 'The :attribute is not a valid URL.',
    'uuid'       => 'The :attribute must be a valid UUID.',
    'custom'     => [
        'name' => [
            'required' => 'Custom message 1',
            'string'   => 'Custom message 2',
        ],
    ],
    'attributes' => [
        'name' => 'Foo',
        'bar'  => 'Bar',
        'baz'  => 'Baz',
    ],
];
```

--------------------------------

### Install Laravel Lang Attributes

Source: https://laravel-lang.com/packages-attributes.html

Install the package using Composer. This command adds the package as a development dependency.

```bash
composer require --dev laravel-lang/attributes
```

--------------------------------

### Example Request for German Localized Route

Source: https://laravel-lang.com/basic-usage.html

Example cURL request to a German localized route (`/de/foo/show`).

```bash
curl -XGET https://example.com/de/foo/show
```

--------------------------------

### Install Laravel Lang Routes

Source: https://laravel-lang.com/packages-routes.html

Install the package using Composer. This command adds the laravel-lang/routes dependency to your project.

```bash
composer require laravel-lang/routes
```

--------------------------------

### Example Response for Unknown Locale (Redirect)

Source: https://laravel-lang.com/basic-usage.html

Example response indicating a 302 Redirect when an unknown locale is requested.

```text
### 302 Redirect
Location: https://example.com/foo/show
```

--------------------------------

### Localization Middleware Examples

Source: https://laravel-lang.com/packages-routes.html

Demonstrates direct usage of various localization middleware within Laravel routes. Ensure necessary imports are included.

```php
use LaravelLang\Routes\Middlewares\LocalizationByCookie;
use LaravelLang\Routes\Middlewares\LocalizationByHeader;
use LaravelLang\Routes\Middlewares\LocalizationByModel;
use LaravelLang\Routes\Middlewares\LocalizationByParameter;
use LaravelLang\Routes\Middlewares\LocalizationByParameterWithRedirect;
use LaravelLang\Routes\Middlewares\LocalizationBySession;

app('router')
    ->middleware(LocalizationByParameter::class)
    ->get('some/{locale}', fn () => view('welcome'));

app('router')
    ->middleware(LocalizationByParameterWithRedirect::class)
    ->get('some/{locale?}', fn () => view('welcome'));

app('router')
    ->middleware(LocalizationByHeader::class)
    ->get('some', fn () => view('welcome'));

app('router')
    ->middleware(LocalizationByCookie::class)
    ->get('some', fn () => view('welcome'));

app('router')
    ->middleware(LocalizationBySession::class)
    ->get('some', fn () => view('welcome'));

app('router')
    ->middleware(LocalizationByModel::class)
    ->get('some', fn () => view('welcome'));
```

--------------------------------

### Install laravel-lang/common

Source: https://laravel-lang.com/packages-common.html

Install the common package using Composer. This package is recommended for quick dependency updates for application localization.

```bash
composer require laravel-lang/common
```

--------------------------------

### JSON Response Example

Source: https://laravel-lang.com/packages-routes.html

Example of a JSON response for a localized route, showing translated content based on the requested locale.

```json
{
    "show": "Toutes les données ont été chargées."
}
```

```json
{
    "show": "Alle Ressourcen geladen."
}
```

--------------------------------

### Updated Language File Example

Source: https://laravel-lang.com/configuration.html

An example of an updated language file after processing, where comments are automatically deleted.

```php
declare(strict_types=1);

return [
    'failed'   => 'These credentials do not match our records 123456.',
    'throttle' => 'Too many login attempts. Please try again in :seconds seconds.',
    'foo'      => 'bar',
];
```

--------------------------------

### Smart Punctuation Example (After)

Source: https://laravel-lang.com/configuration.html

Example of JSON content after smart punctuation conversion, showing Unicode equivalents for quotes, dashes, and ellipses.

```json
{
    "Some": "“It’s super-configurable… you can even use additional extensions to expand its capabilities – just like this one!”"
}
```

--------------------------------

### Example Request for Unknown Locale

Source: https://laravel-lang.com/basic-usage.html

Example cURL request to a route with an unknown locale (`/as/foo/show`). This typically results in a redirect to the default locale.

```bash
curl -XGET https://example.com/as/foo/show
```

--------------------------------

### LocaleData DTO Example

Source: https://laravel-lang.com/upgrade-publisher-to-15-from-14.html

Illustrates the structure of the LocaleData DTO class, showing the properties for locale code, type, name, native name, localized name, and regional format. Includes examples for non-aliased and aliased locales.

```php
use LaravelLang\Locales\Data\LocaleData;

app()->setLocale('vi');

// Non aliased
LocaleData {
    +code: "de"
    +type: "Latn"
    +name: "German"
    +native: "Deutsch"
    +localized: "Tiếng Đức"
    +regional: "de_DE"
}

// Aliased
LocaleData {
    +code: "de-DE"
    +type: "Latn"
    +name: "German"
    +native: "Deutsch"
    +localized: "Tiếng Đức"
    +regional: "de_DE"
}
```

--------------------------------

### Example Model Suffix Usage

Source: https://laravel-lang.com/configuration.html

Illustrates how the `suffix` parameter is used to specify the translation repository's model suffix.

```php
App\Models\Post::class
App\Models\PostTranslation::class
```

--------------------------------

### Install laravel-lang/lang for Laravel 10

Source: https://laravel-lang.com/packages-common.html

For Laravel 10, manually specify the laravel-lang/lang package version during installation using Composer.

```bash
composer require --dev laravel-lang/lang:^14.0
```

--------------------------------

### Example Request for Invalid Locale

Source: https://laravel-lang.com/basic-usage.html

Example cURL request to a route with an invalid locale (`/qwerty/foo/show`). This also typically results in a redirect to the default locale.

```bash
curl -XGET https://example.com/qwerty/foo/show
```

--------------------------------

### Update Localizations

Source: https://laravel-lang.com/packages-attributes.html

Run this Artisan command to update existing localization files. Ensure you have the package installed.

```bash
php artisan lang:update
```

--------------------------------

### Update Locales Namespace

Source: https://laravel-lang.com/upgrade-publisher-to-15-from-14.html

Replace the old locales namespace with the new one. The example shows the 'Before' and 'After' code.

```php
// Before
LaravelLang\Publisher\Constants\Locales
```

```php
// After
LaravelLang\Locales\Enums\Locale
```

```php
// Before
LaravelLang\Publisher\Constants\Locales::AFRIKAANS; // af

// After
LaravelLang\Locales\Enums\Locale::Afrikaans; // af
```

--------------------------------

### Remove Old Packages

Source: https://laravel-lang.com/upgrade-third-party.html

Run these commands to remove previously installed laravel-lang packages.

```bash
composer remove caouecs/laravel-lang overtrue/laravel-lang arcanedev/laravel-lang andrey-helldar/laravel-lang-publisher
```

```bash
composer remove laravel-lang/publisher laravel-lang/lang laravel-lang/attributes laravel-lang/http-statuses
```

--------------------------------

### German Localization Data

Source: https://laravel-lang.com/packages-routes.html

Example JSON data for German localization.

```json
{
    "Foo": "Alle Ressourcen geladen."
}
```

--------------------------------

### Default Locale Data (Fallback Example)

Source: https://laravel-lang.com/packages-locales.html

Shows the LocaleData structure when a requested locale is not found and the system falls back to the default locale ('de').

```php
// Will return the default locale
LocaleData {
  +code: "de"
  +regional: "de_DE"
  +type: "Latn"
  +native: "Deutsch"
  +localized: "Allemand"
  +country: CountryData {
    +code: "DE"
    +native: "Deutschland"
    +localized: "Allemagne"
  }
  +currency: CurrencyData {
    +code: "EUR"
    +numeric: 978
    +native: "Euro"
    +localized: "euro"
  }
  +direction: Direction {
    +name: "LeftToRight"
    +value: "ltr"
  }
  +locale: Locale {
    +name: "German"
    +value: "de"
  }
}
```

--------------------------------

### Get All Locale Names

Source: https://laravel-lang.com/packages-locale-list.html

Retrieve a list of all locale names, sorted alphabetically by name.

```php
use LaravelLang\LocaleList\Locale;

return Locale::names();
```

--------------------------------

### Require Laravel Lang Packages

Source: https://laravel-lang.com/upgrade-common-to-5-from-4.html

Use these commands to install `laravel-lang/common` as a development dependency and `laravel-lang/locales` when using facades and locales in production.

```bash
composer require laravel-lang/common --dev --quiet
composer require laravel-lang/locales
```

--------------------------------

### PR Title Format Example

Source: https://laravel-lang.com/contributions.html

Example of a Pull Request title that follows the required format: '[locale]: Description'. This format is checked by a regular expression.

```text
[fr]: Added new localization
```

--------------------------------

### French Localization Data

Source: https://laravel-lang.com/packages-routes.html

Example JSON data for French localization.

```json
{
    "Foo": "Toutes les données ont été chargées."
}
```

--------------------------------

### Get All Locale Codes

Source: https://laravel-lang.com/packages-locale-list.html

Retrieve a list of all available locale codes. The output is not sorted.

```php
use LaravelLang\LocaleList\Locale;

return Locale::values();
```

--------------------------------

### Get All Locale Codes with Names

Source: https://laravel-lang.com/packages-locale-list.html

Retrieve a list of all locales as key-value pairs, where keys are locale names and values are locale codes.

```php
use LaravelLang\LocaleList\Locale;

return Locale::options();
```

--------------------------------

### Example of Inline vs. Normal Translations

Source: https://laravel-lang.com/contributions.html

Illustrates the difference between normal and inline translations in localization files. Inline translations should not contain attribute references like ':attribute'.

```text
// It's a normal
The :attribute must contain at least one letter.

// It's a inline
This field must contain at least one letter.
```

--------------------------------

### Get Localized Locale Name

Source: https://laravel-lang.com/packages-native-locale-names.html

Retrieve the localized name for a given locale code or enum. Uses 'bn' (Bengali) as an example.

```php
use LaravelLang\NativeLocaleNames\LocaleNames;
use LaravelLang\LocaleList\Locale;

return LocaleNames::get('bn');
// or
return LocaleNames::get(Locale::Bengali);
```

--------------------------------

### Locale Folder Structure with Aliases

Source: https://laravel-lang.com/configuration.html

Installed locales will use the specified aliases as folder names for PHP translations and file names for JSON translations.

```text
lang
    de-CH
    de-DE
```

--------------------------------

### Localization via Accept-Language Header

Source: https://laravel-lang.com/packages-routes.html

Sets localization based on the `Accept-Language` header. If an incorrect or unset localization is submitted, the page will render according to the main localization installed in the application.

```php
use LaravelLang\Routes\Middlewares\LocalizationByHeader;

app('router')
    ->middleware(LocalizationByHeader::class)
    ->get('foo/{bar}', function (string $bar) {
        return response()->json([
            $bar => __('Foo'),
        ]);
    });
```

```bash
curl -XGET 'https://example.com/foo/show' \
--header 'Accept-Language: de'
```

```json
{
    "show": "Alle Ressourcen geladen."
}
```

```bash
curl -XGET 'https://example.com/foo/show' \
--header 'Accept-Language: as'
```

```json
{
    "show": "Toutes les données ont été chargées."
}
```

```bash
curl -XGET 'https://example.com/foo/show' \
--header 'Accept-Language: qwerty'
```

```json
{
    "show": "Toutes les données ont été chargées."
}
```

--------------------------------

### Add Catalan Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Catalan localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add ca
```

--------------------------------

### Localization via Session

Source: https://laravel-lang.com/packages-routes.html

Sets localization based on the `Accept-Language` session key. If an incorrect or unset localization is transferred, the page will be rendered according to the main localization installed in the application. Working with sessions is similar to cookies, differing only in storage location.

```php
use LaravelLang\Routes\Middlewares\LocalizationBySession;

app('router')
    ->middleware(LocalizationBySession::class)
    ->get('foo/{bar}', function (string $bar) {
        return response()->json([
            $bar => __('Foo'),
        ]);
    });
```

```bash
echo "Accept-Language=de" >> cookies.txt

curl -XGET https://example.com/foo/show \
-b cookies.txt -c cookies.txt
```

```json
{
    "show": "Alle Ressourcen geladen."
}
```

```bash
echo "Accept-Language=as" >> cookies.txt

curl -XGET https://example.com/foo/show \
-b cookies.txt -c cookies.txt
```

```json
{
    "show": "Toutes les données ont été chargées."
}
```

```bash
echo "Accept-Language=qwerty" >> cookies.txt

curl -XGET https://example.com/foo/show \
-b cookies.txt -c cookies.txt
```

```json
{
    "show": "Toutes les données ont été chargées."
}
```

--------------------------------

### Listen to Translation Events in Service Provider

Source: https://laravel-lang.com/packages-models.html

Register event listeners in your `AppServiceProvider` to react to translation changes. This example shows logging actions for forgetting all translations, forgetting a single translation, and setting a new translation.

```php
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\ServiceProvider;
use LaravelLang\Models\Events\AllTranslationsHasBeenForgetEvent;
use LaravelLang\Models\Events\TranslationHasBeenForgetEvent;
use LaravelLang\Models\Events\TranslationHasBeenSetEvent;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Event::listen(static function (AllTranslationsHasBeenForgetEvent $event) {
            Log::info('Forget all locales', [
                'model' => $event->model->getKey(),
            ]);
        });

        Event::listen(static function (TranslationHasBeenForgetEvent $event) {
            Log::info('Forget locale', [
                'model'  => $event->model->getKey(),
                'locale' => $event->locale?->value,
            ]);
        });

        Event::listen(static function (TranslationHasBeenSetEvent $event) {
            Log::info('Set new translation', [
                'model'  => $event->model->getKey(),
                'locale' => $event->locale?->value,
                'column' => $event->column,

                'old' => $event->oldValue,
                'new' => $event->newValue,
            ]);
        });
    }
}
```

--------------------------------

### Add Basque Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Basque localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add eu
```

--------------------------------

### Add Azerbaijani Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Azerbaijani localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add az
```

--------------------------------

### LocaleData Structure for Another Specific Locale

Source: https://laravel-lang.com/packages-locales.html

Example of the LocaleData structure for another specific locale ('ar'). This demonstrates the data for a right-to-left language, including its specific country and currency details.

```php
LocaleData {
  +code: "ar"
  +regional: "ar_AE"
  +type: "Arab"
  +native: "العربية"
  +localized: "Arabe"
  +country: CountryData {
    +code: "EG"
    +native: "مصر"
    +localized: "Égypte"
  }
  +currency: CurrencyData {
    +code: "EGP"
    +numeric: 818
    +native: "جنيه مصري"
    +localized: "livre égyptienne"
  }
  +direction: Direction {
    +name: "RightToLeft"
    +value: "rtl"
  }
  +locale: Locale {
    +name: "Arabic"
    +value: "ar"
  }
}
```

--------------------------------

### Sort Country Names by Key

Source: https://laravel-lang.com/packages-native-country-names.html

Get country names sorted alphabetically by their keys (ISO codes). Requires importing the SortBy enum.

```php
use LaravelLang\NativeCountryNames\CountryNames;
use LaravelLang\NativeCountryNames\Enums\SortBy;

return CountryNames::get('en', SortBy::Key);
```

--------------------------------

### Add Arabic Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Arabic localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add ar
```

--------------------------------

### Listen to Locale Event

Source: https://laravel-lang.com/packages-routes.html

Listen to the LocaleHasBeenSetEvent to perform actions when a locale is set. This example logs the locale code. Ensure you are using laravel-lang/routes version 1.1 or higher.

```php
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\ServiceProvider;
use LaravelLang\Routes\Events\LocaleHasBeenSetEvent;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Event::listen(static function (LocaleHasBeenSetEvent $event) {
            Log::info('Locale set to: ' . $event->locale->code);
        });
    }
}
```

--------------------------------

### Add Albanian Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Albanian localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add sq
```

--------------------------------

### Get Specific Locale Data (Fallback to Default)

Source: https://laravel-lang.com/packages-locales.html

Retrieves data for a specific locale ('foo'). If the locale is not found, it defaults to the application's default locale, returning its data.

```php
use LaravelLang\LocaleList\Direction;
use LaravelLang\LocaleList\Locale;
use LaravelLang\Locales\Data\CountryData;
use LaravelLang\Locales\Data\CurrencyData;
use LaravelLang\Locales\Data\LocaleData;
use LaravelLang\Locales\Facades\Locales;

// config('app.locale') // de

return Locales::get('foo', withCountry: true, withCurrency: true);
```

--------------------------------

### Localization via Cookie

Source: https://laravel-lang.com/packages-routes.html

Sets localization based on the `Accept-Language` cookie. If an incorrect or unset localization is transferred, the page will be rendered according to the main localization installed in the application.

```php
use LaravelLang\Routes\Middlewares\LocalizationByCookie;

app('router')
    ->middleware(LocalizationByCookie::class)
    ->get('foo/{bar}', function (string $bar) {
        return response()->json([
            $bar => __('Foo'),
        ]);
    });
```

```bash
curl -XGET https://example.com/foo/show \
-b "Accept-Language=de"
```

```json
{
    "show": "Alle Ressourcen geladen."
}
```

```bash
curl -XGET https://example.com/foo/show \
-b "Accept-Language=as"
```

```json
{
    "show": "Toutes les données ont été chargées."
}
```

```bash
curl -XGET https://example.com/foo/show \
-b "Accept-Language=qwerty"
```

```json
{
    "show": "Toutes les données ont été chargées."
}
```

--------------------------------

### Reset Locale Files to Default

Source: https://laravel-lang.com/usage-reset-locales.html

Use this console command to clear target locale files of keys not defined by Laravel Lang packages or installed third-party plugins.

```bash
php artisan lang:reset
```

--------------------------------

### Require Laravel Lang Common for Development

Source: https://laravel-lang.com/upgrade-common-to-5-from-4.html

If locales are not used in production, this command installs `laravel-lang/common` as a development dependency. It can be used as an alternative to modifying `composer.json` and running `composer update`.

```bash
composer require laravel-lang/common --dev --quiet
```

--------------------------------

### Run Migrations

Source: https://laravel-lang.com/packages-models.html

After creating the translation model and its migration file, run this command to apply the database schema changes.

```bash
php artisan migrate
```

--------------------------------

### Generate IDE Helper Files

Source: https://laravel-lang.com/packages-models.html

Run this command to generate helper files that improve IDE support for translatable fields. This is automatically handled when using 'make:model-translation'.

```bash
php artisan lang:models-helper
```

--------------------------------

### Publish Configuration File

Source: https://laravel-lang.com/configuration.html

Use this Artisan command to publish the localization configuration file to your project.

```bash
php artisan vendor:publish --tag="localization"
```

--------------------------------

### Get Raw Default Locale

Source: https://laravel-lang.com/packages-locales.html

Retrieves the raw default locale identifier using the Locales::raw() method. This is useful for getting just the locale code string.

```php
return Locales::raw()->getDefault();
// Non aliased
// de

// Aliased
// de-DE
```

--------------------------------

### Alternative Localized Group Methods

Source: https://laravel-lang.com/basic-usage.html

Demonstrates three alternative ways to define a localized route group: using `app('router')->localizedGroup`, `Route::localizedGroup`, and `LocalizationRoute::group`.

```php
use Illuminate\support\facades\route;
use LaravelLang\routes\facades\localizationroute;

app('router')->localizedGroup(fn () => ...)

route::localizedGroup(fn () => ...)

localizationroute::group(fn () => ...)
```

--------------------------------

### Get Raw Specific Locale

Source: https://laravel-lang.com/packages-locales.html

Retrieves the raw locale identifier for a specific locale using Locales::raw()->get(). If the locale is not found, it returns the default locale identifier.

```php
return Locales::raw()->get('de');
// de

return Locales::raw()->get('foo');
// Will return the default locale
// de
```

--------------------------------

### Apply Code Style Formatting

Source: https://laravel-lang.com/contributions.html

Run this composer command to format your code according to the PER coding standard and PSR-4 autoloading standard followed by the Laravel-Lang Team.

```bash
composer style
```

--------------------------------

### Usage - Data Objects

Source: https://laravel-lang.com/packages-locales.html

Demonstrates how to use the `LaravelLang\Locales\Facades\Locales` facade to retrieve locale information as data objects.

```APIDOC
## Usage - Data Objects

To work with locales, you can use the facade `LaravelLang\Locales\Facades\Locales`. It allows you to receive information in two ways: a list of locale codes or an array of DTO objects.

```php
use LaravelLang\LocaleList\Locale;
use LaravelLang\Locales\Data\LocaleData;
use LaravelLang\Locales\Facades\Locales;

// List of available localizations.
Locales::available(): array // array<LocaleData>

// List of installed localizations.
Locales::installed(bool $withProtects = true): array // array<LocaleData>

// List of uninstalled localizations.
Locales::notInstalled(): array // array<LocaleData>

// Retrieving a list of protected locales.
Locales::protects(): array // array<LocaleData>

// Check if language packs are available in requested locale.
Locales::isAvailable(LocaleData|Locale|string|null $locale): bool

// Check if a language pack is installed.
Locales::isInstalled(LocaleData|Locale|string|null $locale): bool

// The checked locale protecting.
Locales::isProtected(LocaleData|Locale|string|null $locale): bool

// Validate and returns the correct localization.
// If an uninstalled localization is requested, then it will return the currently active one in the application.
Locales::get(mixed $locale): LocaleData

// Getting the default localization name.
Locales::getDefault(): LocaleData

// Getting the fallback localization name.
Locales::getFallback(): LocaleData

// Receives information about any available localization, otherwise it will return the currently active one in the application.
Locales::info(mixed $locale): LocaleData
```
```

--------------------------------

### Get a Specific Locale Enum Value

Source: https://laravel-lang.com/packages-locale-list.html

Access a specific locale using its enum name.

```php
use LaravelLang\LocaleList\Locale;

return Locale::Bengali;
```

--------------------------------

### Usage - Raw Data

Source: https://laravel-lang.com/packages-locales.html

Demonstrates how to use the `LaravelLang\Locales\Facades\Locales` facade to retrieve locale information as raw strings.

```APIDOC
## Usage - Raw Data

```php
use LaravelLang\LocaleList\Locale;
use LaravelLang\Locales\Data\LocaleData;
use LaravelLang\Locales\Facades\Locales;

// List of available localizations.
Locales::raw()->available(): array // array<string>

// List of installed localizations.
Locales::raw()->installed(bool $withProtects = true): array // array<string>

// List of uninstalled localizations.
Locales::raw()->notInstalled(): array // array<string>

// Retrieving a list of protected locales.
Locales::raw()->protects(): array // array<string>

// Check if language packs are available in requested locale.
Locales::raw()->isAvailable(LocaleData|Locale|string|null $locale): bool

// Check if a language pack is installed.
Locales::raw()->isInstalled(LocaleData|Locale|string|null $locale): bool

// The checked locale protecting.
Locales::raw()->isProtected(LocaleData|Locale|string|null $locale): bool

// Validate and returns the correct localization.
// If an uninstalled localization is requested, then it will return the currently active one in the application.
Locales::raw()->get(mixed $locale): string

// Getting the default localization name.
Locales::raw()->getDefault(): string

// Getting the fallback localization name.
Locales::raw()->getFallback(): string

// Receives locale code for any available localization, otherwise it will return the currently active one in the application.
Locales::raw()->info(mixed $locale): string
```
```

--------------------------------

### Create Translation Model with Columns

Source: https://laravel-lang.com/packages-models.html

Specify the columns to be added to the translation model using the --columns flag. This is useful for defining fields like 'title' or 'description'.

```bash
--columns=title --columns=description
```

--------------------------------

### Create Model with Translations

Source: https://laravel-lang.com/packages-models.html

Create a new model instance and populate its fields, including translations, using the create method.

```php
use App\Models\Article;

Article::create([
    'title' => 'New value',
]);
```

--------------------------------

### Get Translation for Specific Locale

Source: https://laravel-lang.com/basic-usage.html

Retrieve a translation for a specific locale by passing the localization code as the second argument to the `getTranslation` method.

```php
use App\Models\Article;

$page = Article::first();

$page->getTranslation('title', 'fr');
// or
$page->getTranslation('title', Locale::French);
```

--------------------------------

### Localization via URL Parameter With Redirect

Source: https://laravel-lang.com/packages-routes.html

Employ the `LocalizationByParameterWithRedirect` middleware to manage localization through a URL parameter. If an invalid or missing locale is detected, the user will be redirected to the application's default locale. The parameter name is configurable.

```php
use LaravelLang\Routes\Middlewares\LocalizationByParameterWithRedirect;

app('router')
    ->middleware(LocalizationByParameterWithRedirect::class)
    ->get('some/{foo}/bar/{locale?}', function (string $foo) {
        return response()->json([
            $foo => __('Foo'),
        ]);
    });

```

--------------------------------

### Get Native Locale Names

Source: https://laravel-lang.com/packages-native-locale-names.html

Retrieve a list of native locale names. This is the default behavior when no parameter or an invalid/empty parameter is passed.

```php
use LaravelLang\NativeLocaleNames\LocaleNames;

return LocaleNames::get();
// or
return LocaleNames::get('');
// or
return LocaleNames::get(null);
// or
return LocaleNames::get('foo');
```

--------------------------------

### Cache Routes

Source: https://laravel-lang.com/packages-routes.html

Run this Artisan command to cache your application's routes. This is supported by the package.

```bash
php artisan route:cache
```

--------------------------------

### Add Bulgarian Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Bulgarian localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add bg
```

--------------------------------

### Rename Configuration File

Source: https://laravel-lang.com/upgrade-publisher-to-15-from-14.html

Rename the configuration file from config/lang-publisher.php to config/localization.php.

```bash
mv config/lang-publisher.php config/localization.php
```

--------------------------------

### Add Bosnian Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Bosnian localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add bs
```

--------------------------------

### Add Bhojpuri Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Bhojpuri localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add bho
```

--------------------------------

### Configure Translator Channels and Options

Source: https://laravel-lang.com/configuration.html

Activate default translators or create custom ones, and configure options like preserving parameters. This setting is available in the `config/localization.php` file.

```php
return [
    'translators' => [
        'channels' => [
            'google' => [
                'translator' => '\LaravelLang\Translator\Integrations\Google',

                'enabled'  => (bool) env('TRANSLATION_GOOGLE_ENABLED', true),
                'priority' => (int) env('TRANSLATION_GOOGLE_PRIORITY', 1),
            ],

            'deepl' => [
                'translator' => '\LaravelLang\Translator\Integrations\Deepl',

                'enabled'  => (bool) env('TRANSLATION_DEEPL_ENABLED', false),
                'priority' => (int) env('TRANSLATION_DEEPL_PRIORITY', 2),

                'credentials' => [
                    'key' => (string) env('TRANSLATION_DEEPL_KEY'),
                ],
            ],

            'yandex' => [
                'translator' => '\LaravelLang\Translator\Integrations\Yandex',

                'enabled'  => (bool) env('TRANSLATION_YANDEX_ENABLED', false),
                'priority' => (int) env('TRANSLATION_YANDEX_PRIORITY', 3),

                'credentials' => [
                    'key'    => (string) env('TRANSLATION_YANDEX_KEY'),
                    'folder' => (string) env('TRANSLATION_YANDEX_FOLDER_ID'),
                ],
            ],
        ],

        'options' => [
            'preserve_parameters' => true,
        ],
    ],
];
```

--------------------------------

### Add Bangla Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Bangla localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add bn
```

--------------------------------

### Configure Route Names and Middlewares

Source: https://laravel-lang.com/configuration.html

Override default route key names and define middleware groups for localization. This configuration is found in `config/localization.php`.

```php
use LaravelLang\Config\Constants\RouteName;

return [
    'routes' => [
        'names' => [
            'parameter' => RouteName::Parameter,
            'header'    => RouteName::Header,
            'cookie'    => RouteName::Cookie,
            'session'   => RouteName::Session,
            'column'    => RouteName::Column,
        ],

        'name_prefix' => env('LOCALIZATION_NAME_PREFIX', 'localized.'),
        'redirect_default' => (bool) env('LOCALIZATION_REDIRECT_DEFAULT', false),
        'hide_default' => (bool) env('LOCALIZATION_HIDE_DEFAULT', false),

        'group' => [
            'middlewares' => [
                'default' => [
                    LaravelLang\Routes\Middlewares\LocalizationByCookie::class,
                    LaravelLang\Routes\Middlewares\LocalizationByHeader::class,
                    LaravelLang\Routes\Middlewares\LocalizationBySession::class,
                    LaravelLang\Routes\Middlewares\LocalizationByModel::class,
                ],
                'prefix' => [
                    LaravelLang\Routes\Middlewares\LocalizationByParameterPrefix::class,
                    LaravelLang\Routes\Middlewares\LocalizationByCookie::class,
                    LaravelLang\Routes\Middlewares\LocalizationByHeader::class,
                    LaravelLang\Routes\Middlewares\LocalizationBySession::class,
                    LaravelLang\Routes\Middlewares\LocalizationByModel::class,
                ],
            ],
        ],
    ],
];
```

--------------------------------

### Localization via URL Parameter

Source: https://laravel-lang.com/packages-routes.html

Use the `LocalizationByParameter` middleware to handle localization based on a `{locale}` parameter in the URL. The parameter name can be configured in `config/localization.php`. If an incorrect or unset locale is provided, the application's default locale is used.

```php
use LaravelLang\Routes\Middlewares\LocalizationByParameter;

app('router')
    ->middleware(LocalizationByParameter::class)
    ->get('foo/{locale}/{bar}', function (string $bar) {
        return response()->json([
            $bar => __('Foo'),
        ]);
    });

```

--------------------------------

### Add Belarusian Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Belarusian localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add be
```

--------------------------------

### Add Multiple Locales

Source: https://laravel-lang.com/usage-add-locales.html

Use this command to add one or more locales to your project. Separate multiple locale codes with a space.

```bash
php artisan lang:add fr de de_AT de_CH vi zh_CN
```

--------------------------------

### Add Bambara Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Bambara localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add bm
```

--------------------------------

### Add Dogri Localization

Source: https://laravel-lang.com/available-locales-list.html

Run this command to add Dogri localization to your Laravel application.

```bash
php artisan lang:add doi
```

--------------------------------

### Add Assamese Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Assamese localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add as
```

--------------------------------

### Add Armenian Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Armenian localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add hy
```

--------------------------------

### Add Amharic Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Amharic localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add am
```

--------------------------------

### Add New Locale

Source: https://laravel-lang.com/basic-usage.html

Add new localizations using the `lang:add` console command. The list of available localizations can be found in the documentation.

```bash
php artisan lang:add <locale>
```

--------------------------------

### Generate Localized URL with Helper

Source: https://laravel-lang.com/basic-usage.html

Use the `localizedRoute` helper function to generate localized URLs. You can specify the route name, parameters, and optionally the locale.

```php
localizedroute('show', ['bar' => 'show']);
// https://example.com/fr/foo/show

localizedroute('show', ['bar' => 'show', 'locale' => 'de']);
// https://example.com/de/foo/show

localizedroute('localized.show', ['bar' => 'show']);
// https://example.com/fr/foo/show

localizedroute('localized.show', ['bar' => 'show', 'locale' => 'de']);
// https://example.com/de/foo/show
```

--------------------------------

### Add Afrikaans Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add Afrikaans localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add af
```

--------------------------------

### Specify Multiple Locales for Lang Command

Source: https://laravel-lang.com/manage-locales.html

Use this command to specify a list of locales separated by spaces for lang package commands.

```bash
php artisan lang:<command> fr de de_AT de_CH vi zh_CN
```

--------------------------------

### Dispatch Locale Event

Source: https://laravel-lang.com/packages-routes.html

Dispatch the LocaleHasBeenSetEvent when a localization parameter is passed to install it in the application. The event is available in the laravel-lang/routes package version 1.1 and higher.

```php
use LaravelLang\Routes\Events\LocaleHasBeenSetEvent;

LocaleHasBeenSetEvent::dispatch($locale);
```

--------------------------------

### Apply Middleware Aliases to Routes

Source: https://laravel-lang.com/packages-routes.html

Apply registered middleware aliases to specific routes using the `middleware` method on the router. This allows for granular control over which routes use specific localization strategies.

```php
app('router')
    ->middleware('localization.parameter')
    ->get('some/{locale}', fn () => view('welcome'));

app('router')
    ->middleware('localization.redirect')
    ->get('some/{locale?}', fn () => view('welcome'));

app('router')
    ->middleware('localization.header')
    ->get('some', fn () => view('welcome'));

app('router')
    ->middleware('localization.cookie')
    ->get('some', fn () => view('welcome'));

app('router')
    ->middleware('localization.session')
    ->get('some', fn () => view('welcome'));

app('router')
    ->middleware('localization.model')
    ->get('some', fn () => view('welcome'));

```

--------------------------------

### Get Native Country Names (Default/Fallback)

Source: https://laravel-lang.com/packages-native-country-names.html

Retrieve country names using the default locale or when an invalid/empty locale is provided. This serves as a fallback mechanism.

```php
use LaravelLang\NativeCountryNames\CountryNames;

return CountryNames::get();
// or
return CountryNames::get('');
// or
return CountryNames::get(null);
// or
return CountryNames::get('foo');
```

--------------------------------

### Add English Localization

Source: https://laravel-lang.com/available-locales-list.html

Run this command to add English localization to your Laravel application.

```bash
php artisan lang:add en
```

--------------------------------

### Create Translation Model

Source: https://laravel-lang.com/packages-models.html

Use this artisan command to generate a new translation model for your existing Eloquent models. You will be prompted for the source model and columns.

```bash
php artisan make:model-translation
```

--------------------------------

### Add English (Canada) Localization to Laravel

Source: https://laravel-lang.com/available-locales-list.html

Use this command to add English (Canada) localization to your Laravel application. Ensure you have the Laravel Lang package installed.

```bash
php artisan lang:add en_CA
```

--------------------------------

### Configure Application Locales

Source: https://laravel-lang.com/packages-routes.html

Set the default locale and fallback locale in the application's configuration file. Uses constants from LaravelLang\LocaleList\Locale.

```php
// config/app.php
use LaravelLang\LocaleList\Locale;

return [
    'locale' => Locale::French->value,

    'fallback_locale' => Locale::German->value,
];
```

--------------------------------

### Get Translation for Current Locale

Source: https://laravel-lang.com/basic-usage.html

Retrieve the translated value of a model property for the current locale. If the main locale is missing, it falls back to the fallback locale.

```php
use App\Models\Article;

$page = Article::first();

$page->title;
```

--------------------------------

### Get Localized Country Names

Source: https://laravel-lang.com/packages-native-country-names.html

Fetch country names in a specific locale using the locale code or enum. Ensure the LaravelLang\LocaleList\Locale enum is imported if used.

```php
use LaravelLang\NativeCountryNames\CountryNames;
use LaravelLang\LocaleList\Locale;

return CountryNames::get('bn');
// or
return CountryNames::get(Locale::Bengali);
```
Tokens:
Raw