- Removed Laravel 5.6 & 6.x & 7.x support

- Added Laravel 9.x support

Author: sertxudev

README.md

@@ -4,12 +4,12 @@
 **Manage localized routes and use translatable models in a Laravel app.**
  - Automatically register the routes for each locale you wish to support.
  - Optionally remove the locale slug from the URL for your main language.
- - Generate localized route URL's using the ``trans_route()`` helper.
+ - Generate localized route URLs using the `trans_route()` helper.
  - Allow routes to be cached.
 
 ## Requirements
-  - PHP >= 7.1
-  - Laravel >= 5.6
+  - PHP >= 7.4
+  - Laravel >= 7.x
 
 ## Installation
 You can install this package using Composer.
@@ -22,22 +22,22 @@ composer require sertxudeveloper/laravel-translatable
 First you should publish the configuration file.
 
 ```sh
-php artisan vendor:publish --provider="SertxuDeveloper\Translatable\TranslatableServiceProvider" --tag="config"
+php artisan vendor:publish --tag='trans-config'
 ```
 
-After running this command, you will now find a ``translatable.php`` file in the ``config`` folder.
+After running this command, you will now find a `translatable.php`` file in the `config` folder.
 
-### Locales availables
+### Locales available
 You can set the locales availables in your application. The localized routes will be registered with all of these locales.
 
 ```php
-"locales" => ["es", "en", "it"],
+'locales' => ['es', 'en', 'it'],
 ```
 ### Fallback locale
 The fallback locale should be the one that not require to be translated.
 
 ```php
-"fallback_locale" => "es",
+'fallback_locale' => 'es',
 ```
 You can also hide the fallback locale from the URL prefix.
 
@@ -47,20 +47,20 @@ You can also hide the fallback locale from the URL prefix.
 
 # Routes
 ## Register Routes
-All the routes you want lo localize should be registered inside the ``Route::localized`` closure.
+All the routes you want lo localize should be registered inside the `Route::localized` closure.
 
 ```php
 // Not Localized
-Route::get('home', HomeController::class.'@index')->name('home');
+Route::get('home', [HomeController::class, 'index'])->name('home');
 
 // Localized
 Route::localized(function () {
-  Route::get('blog', BlogController::class.'@index')->name('blog')
-  Route::get('{slug}', PageController::class.'@index')->name('page')
+  Route::get('blog', [BlogController::class, 'index'])->name('blog')
+  Route::get('{slug}', [PageController::class, 'index'])->name('page')
 });
 
 // Not Localized
-Route::get('about', AboutController::class.'@index')->name('about');
+Route::get('about', [AboutController::class, 'index'])->name('about');
 ```
 
 Inside this closure you can use Route Groups such as Middlewares, Namespaces or even Sub-Domain Routing. This closure will prepend the locale to the route's URI and name.
@@ -86,13 +86,13 @@ This will be the result of the viewed configuration examples.
 > Beware that you don't register the same URL twice when omitting the locale. You can't have a localized /about route and also register a non-localized /about route in this case. The same idea applies to the / (root) route! Also note that the route names still have the locale prefix.
 
 ## Generate Localized URLs
-You should use the ``trans_route`` helper in order to get the requested route localized. To this helper you can pass a route name or a route url, in booth cases it will be localized.
+You should use the `trans_route` helper in order to get the requested route localized. To this helper you can pass a route name or a route url, in booth cases it will be localized.
 
 ```php
 trans_route($name, $parameters = [], $absolute = false, $locale = null)
 ```
 
-If you pass only the route it will be localized using the current locale (``'en'``).
+If you pass only the route it will be localized using the current locale (`'en'`).
 
 ```php
 trans_route('blog') // /en/blog
@@ -107,7 +107,7 @@ trans_route('page', ['help']) // /en/help
 The third param is a boolean to make it absolute or not.
 
 ```php
-trans_route('page', ['help'], true) // http://your_server_address/en/help
+trans_route('page', ['help'], true) // https://yourdomain.test/en/help
 ```
 
 ```php
@@ -121,7 +121,7 @@ trans_route('blog', [], false, 'it') // /it/blog
 ```
 
 ## Switch Locale
-If your building a dropdown or similar with links to change the locale of the application, you should use the ``switch_to_locale`` helper.
+If you're building a dropdown or similar with links to change the locale of the application, you should use the `switch_to_locale` helper.
 ```php
 switch_to_locale('en') // Changes to 'en' locale without changing the route
 ```
@@ -132,12 +132,14 @@ switch_to_locale('en') // Changes to 'en' locale without changing the route
 You can to customize the name of the translations tables.
 
 ```php
-"table_sufix" => "_translations"
+'table_suffix' => '_translations'
 ```
 
-The usage of this value will be the following one. If you have the model ``Page`` with the trait ``HasTranslations`` and the model table is ``pages``. This package will lookup for the translations at the table ``page_translations``. Always the model table followed by the table suffix in the config file.
+The usage of this value will be the following one. If you have the model `Page` with the trait `HasTranslations` and the model table is `pages`.
+This package will look up for the translations at the table `page_translations`. Always the model table followed by the table suffix in the config file.
 
-The translations tables should contain the translatable fields from the model, the id, a column ``locale`` to specify the language saved, ``created_at`` and ``updated_at``. The column ``deleted_at`` should **never** be in the translations table, regardless the models is ``softDeleted`` or not.
+The translations tables should contain the translatable fields from the model, the id, a column `locale` to specify the language saved, `created_at` and `updated_at`.
+The column `deleted_at` should **never** be in the translations table, regardless the models is `softDeleted` or not.
 
 As you can see in the following example, 
 
@@ -160,10 +162,10 @@ echo $post->getTranslated('name');
 ```
 
 ## Cache Routes
-In production you can safely cache your routes per usual.
+In production, you can safely cache your routes per usual.
 
 ```sh
 php artisan route:cache
 ```
 <br><br>
-Copyright (c) 2019 Sertxu Developer
+Copyright © 2019 Sertxu Developer

composer.json

@@ -2,7 +2,7 @@
   "name": "sertxudeveloper/laravel-translatable",
   "description": "Manage localized routes and use translatable models in a Laravel app.",
   "keywords": ["laravel", "translatable", "localization"],
-  "version": "1.5.0",
+  "version": "1.6.0",
   "license": "MIT",
   "authors": [
     {
@@ -12,8 +12,8 @@
   ],
   "minimum-stability": "dev",
   "require": {
-    "php": "^7.1|^8.0",
-    "illuminate/support": "^5.6.0|^6.0|^7.0|^8.0"
+    "php": "^7.4|^8.0",
+    "illuminate/support": "^8.0|^9.0"
   },
   "autoload": {
     "psr-4": {

publishable/config/translatable.php

@@ -5,20 +5,20 @@
     /**
      * The locales available in your project.
      */
-    "locales" => ["es", "en", "it"],
+    'locales' => ['es', 'en', 'it'],
 
     /**
      * The default locale in your project, it will be used if the requested locale is not available.
      */
-    "fallback_locale" => "es",
+    'fallback_locale' => 'en',
 
     /**
      * Hide the default locale from the URL.
      */
-    "hide_fallback_locale" => true,
+    'hide_fallback_locale' => true,
 
     /**
-     * The translations table suffix
+     * The translations' table suffix.
      */
-    "table_suffix" => "_translations"
+    'table_suffix' => '_translations'
 ];

src/Facades/Translatable.php

@@ -5,9 +5,10 @@
 use Illuminate\Support\Facades\Facade;
 
 class Translatable extends Facade {
-  
+
   /**
    * Get the registered name of the component.
+   *
    * @return string
    */
   protected static function getFacadeAccessor() {

src/Helpers/helpers.php

@@ -13,3 +13,20 @@ function switch_to_locale($locale) {
     return Translatable::switchToLocale($locale);
   }
 }
+
+if (!function_exists('is_route')) {
+  function is_route(string $name): bool {
+
+    /** Check route without locales */
+    if (request()->routeIs($name))
+      return true;
+
+    /** Check route with locales */
+    foreach (config('translatable.locales') as $locale) {
+      if (request()->routeIs("$locale.$name"))
+        return true;
+    }
+
+    return false;
+  }
+}

src/Macros/TranslatableRoutesMacro.php

@@ -2,52 +2,49 @@
 
 namespace SertxuDeveloper\Translatable\Macros;
 
+use Closure;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Route;
-use SertxuDeveloper\Translatable\Facades\Translatable;
 use SertxuDeveloper\Translatable\Middleware\TranslatableRoutesHandler;
-use \Closure;
 
 class TranslatableRoutesMacro {
 
   /**
    * Register the macro.
+   *
    * @return void
    */
-  public static function register() {    
+  public static function register() {
     if (!Route::hasMacro('localized')) {
       function registerRoutes($locale, Closure $closure) {
-        // $currentLocale = Translatable::getLocaleFromRequest();
         $fallbackLocale = config('translatable.fallback_locale');
         $hideFallbackLocale = config('translatable.hide_fallback_locale');
 
         $attributes = [];
-        $attributes["middleware"] = [TranslatableRoutesHandler::class];
+        $attributes['middleware'] = [TranslatableRoutesHandler::class];
 
-        $attributes["as"] = "${locale}.";
-        $attributes["prefix"] = $locale;
+        $attributes['as'] = "$locale.";
+        $attributes['prefix'] = $locale;
         Route::group($attributes, $closure);
 
         if ($hideFallbackLocale && $locale === $fallbackLocale) {
           $attributes = [];
-          $attributes["middleware"] = [TranslatableRoutesHandler::class];
+          $attributes['middleware'] = [TranslatableRoutesHandler::class];
           Route::group($attributes, $closure);
         }
       }
-      
+
       Route::macro('localized', function (Closure $closure) {
         $locales = config('translatable.locales');
         $fallbackLocale = config('translatable.fallback_locale');
 
         foreach ($locales as $locale) {
-          if($fallbackLocale === $locale) continue;
+          if ($fallbackLocale === $locale) continue;
           registerRoutes($locale, $closure);
         }
 
         registerRoutes($fallbackLocale, $closure);
-
       });
     }
   }
-
 }

src/Middleware/TranslatableRoutesHandler.php

@@ -13,27 +13,33 @@
 class TranslatableRoutesHandler {
 
   /**
-   * Set language for localized route
+   * Set language for localized route.
+   *
    * @param \Illuminate\Http\Request $request
    * @param \Closure $next
    * @return mixed
    */
   public function handle(Request $request, Closure $next) {
     $params = explode('/', $request->getPathInfo());
+
     // Dump the first element (empty string) as getPathInfo() always returns a leading slash
     array_shift($params);
 
-    if (\count($params) > 0) {
+    if (count($params) > 0) {
       $locale = $params[0];
+
       if (Translatable::checkLocaleInSupportedLocales($locale)) {
         App::setLocale($locale);
+
         if (Translatable::isFallbackLocaleHidden() && Translatable::isFallbackLocale($locale)) {
           array_shift($params);
           $params = implode('/', $params);
-          $url = $request->root() . "/${params}";
+          $url = $request->root() . "/$params";
           $query = http_build_query($request->all());
           $url = ($query) ? "$url?$query" : $url;
+
           Session::reflash();
+
           return new RedirectResponse($url, 302, ['Vary' => 'Accept-Language']);
         }
       }

src/Traits/HasTranslations.php

@@ -10,19 +10,23 @@ trait HasTranslations {
   /**
    * Get the translated $attribute if not exist return the fallback translation
    *
-   * @param $attribute
-   * @param bool $lang
+   * @param string $attribute
+   * @param string|null $lang
    * @return string
    */
-  public function getTranslated($attribute, $lang = false) {
-    if(!$lang) $lang = App::getLocale();
-    if (config('translatable.fallback_locale') === $lang) {
+  public function getTranslated(string $attribute, ?string $lang = null): string {
+    if (!$lang) $lang = App::getLocale();
+
+    if (config('translatable.fallback_locale') === $lang)
       return $this[$attribute];
-    } else {
-      $translation = DB::table($this->table . config('translatable.table_suffix'))->where([['locale', $lang], [$this->getKeyName(), $this->getKey()]])->first();
 
-      return (!isset($translation->$attribute)) ? $this[$attribute] : $translation->$attribute;
-    }
-  }
+    $translation = DB::table($this->table . config('translatable.table_suffix'))
+      ->where([
+        ['locale', $lang], [
+          $this->getKeyName(), $this->getKey(),
+        ],
+      ])->first();
 
+    return (!isset($translation->$attribute)) ? $this[$attribute] : $translation->$attribute;
+  }
 }