Translate a URI or individual slugs.

2.0.0 2024-03-10 12:32 UTC

This package is auto-updated.

Last update: 2024-04-10 12:40:04 UTC


GitHub release Laravel License Build Status Code Coverage Code Quality Total Downloads


This package registers a macro for the Laravel Translator class. This will allow you to translate individual URI slugs, while ignoring parameter placeholders.

Parameters will not be translated by this macro. That remains the responsibility of your code.

✅ Requirements

  • PHP >= 8.1
  • Laravel >= 10.0

📦 Install

Install this package with Composer:

composer require codezero/laravel-uri-translator

Laravel will automatically register the ServiceProvider.

In your app's lang folder, create subdirectories for every locale you want to have translations for.

Next create a routes.php file in each of those directories.

  ├── en/
  │    └── routes.php
  └── nl/
       └── routes.php

Return an array of translations from the routes.php files.

🚀 Usage

Use the Lang::uri() macro when registering routes:

Route::get(Lang::uri('hello/world'), [Controller::class, 'index']);

The URI macro accepts 2 additional parameters:

  1. A locale, in case you need translations to a locale other than the current app locale.
  2. A namespace, in case your translation files reside in a package.
Lang::uri('hello/world', 'fr', 'my-package');

You can also use trans()->uri('hello/world') instead of Lang::uri('hello/world').

🔌 Example

Using these example translations:

// lang/nl/routes.php
return [
    'hello' => 'hallo',
    'world' => 'wereld',
    'override/hello/world' => 'something/very/different',
    'hello/world/{parameter}' => 'uri/with/{parameter}',

These are possible translation results:

// Translate every slug individually
// Translates to: 'hallo/wereld'

// Keep original slug when missing translation
// Translates to: 'hallo/big/wereld'

// Translate slugs, but not parameter placeholders
// Translates to: 'hallo/{world}'

// Translate full URIs if an exact translation exists
// Translates to: 'something/very/different'

// Translate full URIs if an exact translation exists (with placeholder)
// Translates to: 'uri/with/{parameter}'

🚧 Testing

composer test

☕️ Credits

🔒 Security

If you discover any security related issues, please e-mail me instead of using the issue tracker.

📑 Changelog

A complete list of all notable changes to this package can be found on the releases page.

📜 License

The MIT License (MIT). Please see License File for more information.