GitBook: [master] 3 pages modified

Author: Gummibeer

docs/README.md

@@ -53,6 +53,7 @@ echo $post->translate('fr')->title; // Mon premier post
 
 * [How To Add Multilingual Support to Eloquent](https://laravel-news.com/how-to-add-multilingual-support-to-eloquent)
 * [How To Build An Efficient and SEO Friendly Multilingual Architecture For Your Laravel Application](https://mydnic.be/post/how-to-build-an-efficient-and-seo-friendly-multilingual-architecture-for-your-laravel-application)
+* [How to Add Multi-Language Models to Laravel QuickAdminPanel](https://quickadminpanel.com/blog/how-to-add-multi-language-models-to-laravel-quickadminpanel/)
 
 ## Add-Ons
 

docs/SUMMARY.md

@@ -11,4 +11,5 @@
 * [Methods](usage/methods.md)
 * [Scopes](usage/scopes.md)
 * [Fallback locale](usage/fallback-locale.md)
+* [Locales helper](usage/locales-helper.md)
 

docs/usage/locales-helper.md

@@ -0,0 +1,81 @@
+# Locales helper
+
+In addition to the trait we also provide a helper class `\Astrotomic\Translatable\Locales` it's a singleton service available as `translatable.locales` and `\Astrotomic\Translatable\Locales` .  
+This helper manages all locales available for translation and provides several methods.
+
+This class also implements the `ArrayAccess` interface to allow you to use it like a normal array.
+
+## Methods
+
+### load\(\)
+
+This method will \(re\)load all locales from the `translatable.locales` config - it's called during service instantiation so you will only need it if you change the config during runtime.
+
+{% hint style="info" %}
+If you don't have to do so to work with other packages we recommend to use the provided methods of this helper service to manipulate the available locales instead of changing the config during runtime.
+{% endhint %}
+
+### all\(\)
+
+**Alias:** `toArray()`
+
+Returns all available locales as an array - the structure differs from the config one, the return final generated array with combined country locales.
+
+```php
+[
+  'en',
+  'de',
+  'es',
+  'es-MX',
+  'es-CO',
+]
+```
+
+### current\(\)
+
+Returns the current locale string.
+
+### has\(string $locale\)
+
+Checks if the given locale is available in the configured set of locales.
+
+### get\(string $locale\)
+
+Returns the provided locale or `null` if it's not set.
+
+{% hint style="info" %}
+At all this isn't really useful except you want to build your own check if a locale is set.
+{% endhint %}
+
+### add\(string $locale\)
+
+Adds the given locale to the set of available locales.
+
+{% hint style="info" %}
+The set of available locales will keep unique and this method won't throw an exception if the locale is already present.
+{% endhint %}
+
+### forget\(string $locale\)
+
+Removes the given locale of the available locales set.
+
+{% hint style="info" %}
+This method won't throw an exception if the locale isn't present.
+{% endhint %}
+
+### getLocaleSeparator\(\)
+
+Returns the configured `translatable.locale_separator` locale separator used to combine language with country locales.
+
+### getCountryLocale\(string $locale, string $country\)
+
+Returns the formatted country based locale.
+
+### isLocaleCountryBased\(string $locale\)
+
+Checks if the given locale is a country specific locale.
+
+### getLanguageFromCountryBasedLocale\(string $locale\)
+
+Returns the language locale from given country based locale.
+