About Translatable

This package relies on Spatie's Laravel Translatable to handle translations efficiently.

::: tip Learn more about the package we trust to efficiently translate regions within our own package! Spatie's Laravel Translatable :::

Usage

To start using CountryRegionTranslation::class, just add this to your code:

use Lwwcas\LaravelCountries\Models\CountryRegionTranslation;

CountryRegionTranslation::all();

Although this method allows you to access very specific queries within the region translation table for particular purposes, it's not the most common way to utilize all the features that Region translations offer.

::: warning We don't recommend using this approach to access the information. :::

How it Works

The magic happens when you set your default language:

More about config translate

usually in config file app.php as

'locale' => env('APP_LOCALE', 'en')

and in config file translatable.php as

'locales' => [
    'en',
    'fr',
    'es' => [
        'MX', // mexican spanish
        'CO', // colombian spanish
    ],
],

Let's suppose we start with English:

Now, we can perform all kinds of queries on CountryRegion::class in any previously installed language, and we'll access the same region.

::: tip You can find more helpful methods in the Method Listing for these cases. :::

For instance, if we try to find Europe like this:

use Lwwcas\LaravelCountries\Models\CountryRegion;

CountryRegion::::whereName('Europe')->first();

Written in English, we'll get the same Europe as if we search for Europe in Russian:

use Lwwcas\LaravelCountries\Models\CountryRegion;

CountryRegion::::whereName('Европа')->first();

Similarly, if we search using slugs:

use Lwwcas\LaravelCountries\Models\CountryRegion;

CountryRegion::::whereName('Европа')->first();
or
CountryRegion::whereSlug('evropa')->first();

We'll get the same result a CountryRegion::class collection with Europe in English.

Scopes

Returns all regions being translated in:

::: code-group

use Lwwcas\LaravelCountries\Models\CountryRegion as Region;

Region::translatedIn('en')->get();

use Lwwcas\LaravelCountries\Models\CountryRegion as Region;

Region::translatedIn('es')->get();

:::

Returns all regions not being translated in:

::: code-group

use Lwwcas\LaravelCountries\Models\CountryRegion as Region;

Region::notTranslatedIn('en')->get();

use Lwwcas\LaravelCountries\Models\CountryRegion as Region;

Region::notTranslatedIn('es')->get();

:::

Methods

This returns an instance of CountryRegionTranslation::class using the default or given locale. It can also use the configured fallback locale if first locale isn't present.

->translate(?string $locale = null, bool $withFallback = false)

$region->translate(); // returns the german translation model
$region->translate('fr'); // returns the french translation model
$region->translate('it'); // returns null
$region->translate('it', true); // returns the english translation model

This returns an instance of CountryRegionTranslation::class using the default or given locale and will always use fallback if needed.

->translateOrDefault(?string $locale = null)

$region->translateOrDefault(); // returns the german translation model
$region->translateOrDefault('fr'); // returns the french translation model
$region->translateOrDefault('it'); // returns the english translation model

This returns an instance of CountryRegionTranslation::class using the default or given locale and will create a new instance if needed.

->translateOrNew(?string $locale = null)

$region->translateOrNew(); // returns the german translation model
$region->translateOrNew('fr'); // returns the french translation model
$region->translateOrNew('it'); // returns the new italian translation model

Check if the post has a translation in default or given locale.

->hasTranslation(?string $locale = null)

$region->hasTranslation(); // true
$region->hasTranslation('fr'); // true
$region->hasTranslation('cn'); // false

Returns all the translations as array - the structure is the same as it's accepted by the fill(array $data) method.

->getTranslationsArray()

$region->getTranslationsArray();

// Returns
[
 'en' => ['name' => 'Africa'],
 'fr' => ['name' => 'Afrique'],
 'de' => ['name' => 'Afrika'],
];