Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added information about the localization of locale names #127

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"laravel-lang/http-statuses": "^3.5.0",
"laravel-lang/lang": "^13.3.0",
"laravel-lang/locales": "^1.6",
"laravel-lang/native-locale-names": "^1.1",
"laravel-lang/native-locale-names": "^1.2",
"laravel-lang/publisher": "^15.0"
},
"require-dev": {
Expand Down
26 changes: 18 additions & 8 deletions docs/installation/upgrade-guide/publisher/15.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,47 +56,57 @@ Also [changed](../../../usage/aliases.md) `aliases` section in the configuration
### Before

```php
LaravelLang\Publisher\Facades\Helpers\Locales::available(); // array<string>
use LaravelLang\Publisher\Facades\Helpers\Locales;

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

LaravelLang\Publisher\Facades\Helpers\Locales::getDefault(); // string
return Locales::getDefault(); // string
// de-DE
```

### After

```php
LaravelLang\Locales\Facades\Locales::available(); // array<LocaleData>
use LaravelLang\Publisher\Facades\Helpers\Locales;

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

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

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

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

`<object>` is a DTO class of `LocaleData`:

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

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

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

// Aliased
LaravelLang\Locales\Data\LocaleData {
LocaleData {
+code: "de-DE"
+type: "Latn"
+name: "German"
+native: "Deutsch"
+localized: "Tiếng Đức"
+regional: "de_DE"
}
```
Expand Down
27 changes: 23 additions & 4 deletions docs/usage/features/facades.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,46 +39,65 @@ Locales::getFallback(): LocaleData
For example:

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

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

return Locales::getDefault();

// Non aliased
LaravelLang\Locales\Data\LocaleData {
LocaleData {
+code: "de"
+type: "Latn"
+name: "German"
+native: "Deutsch"
+localized: "Deutsch"
+regional: "de_DE"
}

// Aliased
LaravelLang\Locales\Data\LocaleData {
LocaleData {
+code: "de-DE"
+type: "Latn"
+name: "German"
+native: "Deutsch"
+localized: "Deutsch"
+regional: "de_DE"
}
```
```php
use LaravelLang\Locales\Data\LocaleData;
use LaravelLang\Locales\Facades\Locales;

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

return Locales::get('de');

LaravelLang\Locales\Data\LocaleData {
LocaleData {
+code: "de"
+type: "Latn"
+name: "German"
+native: "Deutsch"
+localized: "Tiếng Đức"
+regional: "de_DE"
}
```
```php
use LaravelLang\Locales\Data\LocaleData;
use LaravelLang\Locales\Facades\Locales;

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

return Locales::get('foo');

// Will return the default locale
LaravelLang\Locales\Data\LocaleData {
LocaleData {
+code: "de"
+type: "Latn"
+name: "German"
+native: "Deutsch"
+localized: "Deutsch"
+regional: "de_DE"
}
```
Expand Down