Skip to content

add locales support with i18n #172

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
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
31 changes: 31 additions & 0 deletions app/Http/Controllers/Settings/LanguageController.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

namespace App\Http\Controllers\Settings;

use App\Http\Controllers\Controller;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Validation\Rule;

class LanguageController extends Controller
{
/**
* Update the user's language preference.
*/
public function update(Request $request): RedirectResponse
{
$validated = $request->validate([
'locale' => ['required', 'string', Rule::in(config('app.available_locales'))],
]);

if ($request->user()) {
$request->user()->update([
'locale' => $validated['locale'],
]);
}

$request->session()->put('locale', $validated['locale']);

return back()->with('status', __('messages.language_updated'));
}
}
2 changes: 1 addition & 1 deletion app/Http/Controllers/Settings/PasswordController.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ public function update(Request $request): RedirectResponse
'password' => Hash::make($validated['password']),
]);

return back();
return back()->with('status', __('messages.password_updated'));
}
}
2 changes: 1 addition & 1 deletion app/Http/Controllers/Settings/ProfileController.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public function update(ProfileUpdateRequest $request): RedirectResponse

$request->user()->save();

return to_route('profile.edit');
return to_route('profile.edit')->with('status', __('messages.profile_updated'));
}

/**
Expand Down
6 changes: 6 additions & 0 deletions app/Http/Middleware/HandleInertiaRequests.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Illuminate\Foundation\Inspiring;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\App;
use Inertia\Middleware;
use Tighten\Ziggy\Ziggy;

Expand Down Expand Up @@ -51,6 +52,11 @@ public function share(Request $request): array
'location' => $request->url(),
],
'sidebarOpen' => ! $request->hasCookie('sidebar_state') || $request->cookie('sidebar_state') === 'true',
'locale' => [
'current' => App::getLocale(),
'available' => config('app.available_locales'),
'user_preference' => $request->user()?->locale,
],
];
}
}
82 changes: 82 additions & 0 deletions app/Http/Middleware/SetUserLocale.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\App;
use Symfony\Component\HttpFoundation\Response;

class SetUserLocale
{
/**
* Handle an incoming request.
*
* @param \Closure(Request): (Response) $next
*/
public function handle(Request $request, Closure $next): Response
{
if ($userLocale = $request->user()?->locale) {
App::setLocale($userLocale);

return $next($request);
}

if ($sessionLocale = $request->session()->get('locale')) {
if (in_array($sessionLocale, $this->getSupportedLocales())) {
App::setLocale($sessionLocale);

return $next($request);
}
}

$this->setLocaleFromBrowser($request);

return $next($request);
}

/**
* Set locale based on browser language preferences
*/
private function setLocaleFromBrowser(Request $request): void
{
$browserLocales = $request->getLanguages();
$supportedLocales = $this->getSupportedLocales();

foreach ($browserLocales as $browserLocale) {
$normalizedLocale = str_replace('_', '-', strtolower($browserLocale));

if (in_array($normalizedLocale, $supportedLocales)) {
App::setLocale($normalizedLocale);

return;
}

$languageCode = strtolower(substr($browserLocale, 0, 2));

if (in_array($languageCode, $supportedLocales)) {
App::setLocale($languageCode);

return;
}

foreach ($supportedLocales as $supportedLocale) {
if (str_starts_with($supportedLocale, $languageCode.'-')) {
App::setLocale($supportedLocale);

return;
}
}
}

App::setLocale(config('app.locale'));
}

/**
* Get supported locales from config
*/
private function getSupportedLocales(): array
{
return config('app.available_locales');
}
}
1 change: 1 addition & 0 deletions app/Models/User.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ class User extends Authenticatable
protected $fillable = [
'name',
'email',
'locale',
'password',
];

Expand Down
2 changes: 2 additions & 0 deletions bootstrap/app.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

use App\Http\Middleware\HandleAppearance;
use App\Http\Middleware\HandleInertiaRequests;
use App\Http\Middleware\SetUserLocale;
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
Expand All @@ -18,6 +19,7 @@

$middleware->web(append: [
HandleAppearance::class,
SetUserLocale::class,
HandleInertiaRequests::class,
AddLinkHeadersForPreloadedAssets::class,
]);
Expand Down
16 changes: 16 additions & 0 deletions config/app.php
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,20 @@
'store' => env('APP_MAINTENANCE_STORE', 'database'),
],

/*
|--------------------------------------------------------------------------
| Available Locales
|--------------------------------------------------------------------------
|
| This array defines the list of supported locales for your application.
| These will be used to validate user preferences, detect browser languages,
| and limit localization to only approved languages.
|
*/

'available_locales' => [
'en',
'fr',
],

];
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ public function up(): void
$table->id();
$table->string('name');
$table->string('email')->unique();
$table->string('locale', 5)->default('en');
$table->timestamp('email_verified_at')->nullable();
$table->string('password');
$table->rememberToken();
Expand Down
Loading