https://github.com/torann/localization

Simplified localization for Laravel based on the application's subdomain
https://github.com/torann/localization

Last synced: about 2 months ago
JSON representation

Simplified localization for Laravel based on the application's subdomain

• Host: GitHub
• URL: https://github.com/torann/localization
• Owner: Torann
• License: bsd-2-clause
• Created: 2016-05-03T01:54:27.000Z (about 9 years ago)
• Default Branch: 2.x
• Last Pushed: 2024-03-22T18:51:34.000Z (about 1 year ago)
• Last Synced: 2024-04-22T21:08:14.182Z (about 1 year ago)
• Language: PHP
• Size: 43.9 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Localization - Simplified

[![Build Status](https://app.travis-ci.com/Torann/localization.svg?branch=2.x)](https://app.travis-ci.com/Torann/localization)

[![Latest Stable Version](https://poser.pugx.org/torann/localization/v/stable.png)](https://packagist.org/packages/torann/localization)

[![Total Downloads](https://poser.pugx.org/torann/localization/downloads.png)](https://packagist.org/packages/torann/localization)

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/torann)

[![Donate to this project using Flattr](https://img.shields.io/badge/flattr-donate-yellow.svg)](https://flattr.com/profile/torann)

[![Donate to this project using Paypal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4CJA2A97NPYVU)

Simplified localization for Laravel based on the application's subdomain.

## Table of Contents

- [Installation](#installation])

  - [Composer](#composer)

  - [Laravel](#laravel)

- [Methods](#methods)

- [Helpers](#helpers)

- [Determining Locale](#determining-locale)

- [License](#license)

- [Localization on Packagist](https://packagist.org/packages/torann/localization)

- [Localization on GitHub](https://github.com/Torann/localization)

## Installation

### Composer

From the command line run:

```

$ composer require torann/localization

```

### Laravel

Once installed you need to register the service provider with the application. Open up `config/app.php` and find the `providers` key.

``` php

'providers' => [

    \Torann\Localization\LocalizationServiceProvider::class,

]

```

### Publish the configurations

Run this on the command line from the root of your project:

```bash

php artisan vendor:publish --provider="Torann\Localization\LocalizationServiceProvider"

```

A configuration file will be published to `config/localization.php`.

## Methods

The following methods are available:

- `getDefaultLocale(): string`

- `getCurrentLocale(): string`

- `setLocale(string $locale = null): string|null`

- `getLocales(): array`

- `getLocale(string $key, mixed $default = null): mixed`

- `getLocaleDirection(string $locale = 'current'): string`

- `getLocaleKeys(): array`

- `getLocalizedURL(string $url = null, mixed $locale = false, array $extra = []): string`

- `isSupported(mixed $key): bool`

- `getConfig(string $key, mixed $default = null): mixed`

## Helpers

Laravel Localization comes with a few helper methods

#### `localization()`

Returns the `Torann\Localization\LocaleManager` instance.

#### `localize_url($url = null, $locale = null, $attributes = []): string`

Returns the given URL adapted to provided locale.

## Determining Locale

### By Subdomain

For this to work the subdomain needs to match an enabled supported locale key.

### By Host

When the given subdomain is determined to not be valid the system can then set the locale depending on the current host. You'll need to set a map of your application's locales to hosts using the **hosts** configuration option.

### License

Localization is open-sourced software licensed under the BSD 2-Clause License.