https://github.com/folkloreinc/laravel-locale

Localization package for Laravel 5
https://github.com/folkloreinc/laravel-locale

laravel-localization

Last synced: about 2 months ago
JSON representation

Localization package for Laravel 5

• Host: GitHub
• URL: https://github.com/folkloreinc/laravel-locale
• Owner: folkloreinc
• Created: 2015-09-11T19:24:10.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-08T16:16:35.000Z (6 months ago)
• Last Synced: 2024-10-13T15:14:03.481Z (3 months ago)
• Topics: laravel-localization
• Language: PHP
• Size: 60.5 KB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Laravel Locale

A simple localization package for Laravel 5. It provides URL detection, Route parameters, session storage, and view sharing.

[![Latest Stable Version](https://poser.pugx.org/folklore/laravel-locale/v/stable.svg)](https://packagist.org/packages/folklore/laravel-locale)

[![Build Status](https://travis-ci.org/Folkloreatelier/laravel-locale.png?branch=master)](https://travis-ci.org/Folkloreatelier/laravel-locale)

[![Coverage Status](https://coveralls.io/repos/github/Folkloreatelier/laravel-locale/badge.svg?branch=master)](https://coveralls.io/github/Folkloreatelier/laravel-locale?branch=master)

[![Total Downloads](https://poser.pugx.org/folklore/laravel-locale/downloads.svg)](https://packagist.org/packages/folklore/laravel-locale)

## Installation

#### Dependencies:

##### Version prior to 3.0

* [Laravel <= 5.7](https://github.com/laravel/laravel)

##### Version 3.0 and up

* [Laravel >= 5.5](https://github.com/laravel/laravel)

#### Installation:

**1-** Require the package via Composer in your `composer.json`.

```json

{

	"require": {

		"folklore/laravel-locale": "~3.0"

	}

}

```

**2-** Run Composer to install or update the new requirement.

```bash

$ composer install

```

or

```bash

$ composer update

```

**3-** Add the service provider to your `app/config/app.php` file

```php

\Folklore\LaravelLocale\LocaleServiceProvider::class,

```

**5-** Publish the configuration file

```bash

$ php artisan vendor:publish --provider="Folklore\LaravelLocale\LocaleServiceProvider"

```

**6-** Review the configuration file

```

config/locale.php

```

## Usage

### Define route locale

You can specify the locale of a specific routes:

```php

Route::get('/fr', [

  'as' => 'home.fr',

  'locale' => 'fr',

  function()

  {

    return view('home');

  }

]);

```

### Auto-detection from URL

It is possible to let the package auto-detect the locale from the first part fo the URL.

```php

Route::get('/fr/a-propos', [

  'as' => 'about.fr',

  function()

  {

    return view('home');

  }

]);

```

Be sure to add the supported locales in `config/locale.php`

### View sharing

By default, this package shares two variables to every views `$locale` and `$otherLocales`. The `$otherLocales` variable is an array containing all the other locales than the current one.