Handle field name in route parameter

[blackjak231]

Right now, the current localization system does not handle using field names in route parameters.

Example

Route definitions

french: /ville/{city:slug} --> default language
english: /city/{city:slug}

Using LaravelLocalization::getLocalizedURL() to get the english url, it will return /en/ville/{city:slug}.

After checking, it seems that when getting the attributes it ignores :slug and uses the key city and then tries to find {city} in the translated url to return it.

I wish to not use the route binding on my model as the id and other attributes are used in other places.

Thanks in advance !

[kamranata]

Same issue

[kskrlinnorth2]

Is this fixed?

I switched my routes from /page/{model} to /page/{model:slug} and /some-other-page/{model:id} because in some routes I need to fetch same model via slug and in some via ID and package stopped to translate my routes.

Before routes switch I used this fix (which works for my specific use case where all routes that require slug starts with pages.), this isn't long-term solution and it would be good to fix this small bug:

public function getRouteKeyName()
{
    return request()->route() && str_starts_with(request()->route()->getName(), 'pages.') ? 'slug' : 'id';
}

[mcolominas]

Hi, I'm having the same problem.

It doesn't seem to have been resolved yet. By reviewing the code, I was able to find the reason why it's not working properly. I have two methods to fix it, but both require modifying the package:

Method 1
File: vendor\mcamara\laravel-localization\src\Mcamara\LaravelLocalization\LaravelLocalization.php

protected function substituteAttributesInRoute($attributes, $route, $locale = null)
{
    foreach ($attributes as $key => $value) {
        if ($value instanceOf Interfaces\LocalizedUrlRoutable) {
            $value = $value->getLocalizedRouteKey($locale);
        }
        elseif ($value instanceOf UrlRoutable) {
            $value = $value->getRouteKey();
        }
        
        //Remove this line
        //$route = str_replace(array('{'.$key.'}', '{'.$key.'?}'), $value, $route);

        //Add this line
        $route = preg_replace('/\{'.$key.'(:[^}]*)?\??\}/', $value, $route); 
    }

    // delete empty optional arguments that are not in the $attributes array
    $route = preg_replace('/\/{[^)]+\?}/', '', $route);

    return $route;
}

Tests:

$key = 'product';
$value = 'test';

$route = '/product/{product}';
echo preg_replace('/\{'.$key.'(:[^}]*)?\??\}/', $value, $route); 
// Output: /product/test

$route = '/product/{product:slug}';
echo preg_replace('/\{'.$key.'(:[^}]*)?\??\}/', $value, $route); 
// Output: /product/test

$route = '/product/{product?}';
echo preg_replace('/\{'.$key.'(:[^}]*)?\??\}/', $value, $route); 
// Output: /product/test

Method 2
File: vendor\mcamara\laravel-localization\src\Mcamara\LaravelLocalization\LaravelLocalization.php
I have commented as //------------- ADD THIS ------------- what needs to be added.

protected function extractAttributes($url = false, $locale = '')
{
    if (!empty($url)) {
        $attributes = [];
        $parse = parse_url($url);
        if (isset($parse['path'])) {
            //$parse['path'] = trim(str_replace('/' . $this->currentLocale . '/', '', $parse['path']), "/");
            $url = explode('/', trim($parse['path'], '/'));
        } else {
            $url = [];
        }

        foreach ($this->router->getRoutes() as $route) {
            $attributes = [];
            $path = method_exists($route, 'uri') ? $route->uri() : $route->getUri();

            //------------- ADD THIS -------------
            $binding_fields = [];
            if (method_exists($route, 'bindingFields')) {
                $binding_fields = $route->bindingFields();
            }

            if (!preg_match("/{[\w]+\??}/", $path)) {
                continue;
            }

            $path = explode('/', $path);
            $i = 0;

            // The system's route can't be smaller
            // only the $url can be missing segments (optional parameters)
            // We can assume it's the wrong route
            if (count($path) < count($url)) {
                continue;
            }

            $match = true;
            foreach ($path as $j => $segment) {
                if (isset($url[$i])) {
                    if ($segment === $url[$i]) {
                        $i++;
                        continue;
                    } elseif (preg_match("/{[\w]+}/", $segment)) {
                        // must-have parameters
                        $attribute_name = preg_replace(['/}/', '/{/', "/\?/"], '', $segment);
                        $attributes[$attribute_name] = $url[$i];

                        //------------- ADD THIS -------------
                        if (array_key_exists($attribute_name, $binding_fields)) {
                            $attributes[$attribute_name . ':' . $binding_fields[$attribute_name]] = $attributes[$attribute_name];
                            unset($attributes[$attribute_name]);
                        }

                        $i++;
                        continue;
                    } elseif (preg_match("/{[\w]+\?}/", $segment)) {
                        // optional parameters
                        if (!isset($path[$j + 1]) || $path[$j + 1] !== $url[$i]) {
                            // optional parameter taken
                            $attribute_name = preg_replace(['/}/', '/{/', "/\?/"], '', $segment);

                            $attributes[$attribute_name] = $url[$i];

                            //------------- ADD THIS -------------
                            if (array_key_exists($attribute_name, $binding_fields)) {
                                $attributes[$attribute_name . ':' . $binding_fields[$attribute_name]] = $attributes[$attribute_name];
                                unset($attributes[$attribute_name]);
                            }

                            $i++;
                            continue;
                        } else {
                            $match = false;
                            break;
                        }
                    } else {
                        // As soon as one segment doesn't match, then we have the wrong route
                        $match = false;
                        break;
                    }
                } elseif (preg_match("/{[\w]+\?}/", $segment)) {
                    $attribute_name = preg_replace(['/}/', '/{/', "/\?/"], '', $segment);
                    $attributes[$attribute_name] = null;
                    $i++;
                } else {
                    // no optional parameters but no more $url given
                    // this route does not match the url
                    $match = false;
                    break;
                }
            }

            if (isset($url[$i + 1])) {
                $match = false;
            }

            if ($match) {
                return $attributes;
            }
        }
    } else {
        if (!$this->router->current()) {
            return [];
        }

        $attributes = $this->normalizeAttributes($this->router->current()->parameters());

        //------------- ADD THIS -------------
        if (method_exists($this->router->current(), 'bindingFields')) {
            $binding_fields = $this->router->current()->bindingFields();
            foreach ($binding_fields as $attribute_name => $binding_name) {
                if (array_key_exists($attribute_name, $attributes)) {
                    $newKey = $attribute_name . ':' . $binding_name;
                    $attributes[$newKey] = $attributes[$attribute_name];
                    unset($attributes[$attribute_name]);
                }
            }
        }

        $response = event('routes.translation', [$locale, $attributes]);

        if (!empty($response)) {
            $response = array_shift($response);
        }

        if (\is_array($response)) {
            $attributes = array_merge($attributes, $response);
        }
    }

    return $attributes;
}

In my opinion, I prefer the second method, but you have to keep one thing in mind, if you want to get a specific translated route, you can't use:

LaravelLocalization::getURLFromRouteNameTranslated('en', 'routes.product', ['product' => 'test'], true);

Instead, you have to use:

LaravelLocalization::getURLFromRouteNameTranslated('en', 'routes.product', ['product:slug' => 'test'], true);

Note: I have commented out the $parse['path'] = trim(str_replace('/' . $this->currentLocale . '/', '', $parse['path']), "/"); line, because I have found that $url and $path contain the locale, therefore, removing the locale prefix in $parse['path'] = trim(str_replace('/' . $this->currentLocale . '/', '', $parse['path']), "/");, makes it not find matches.

I discovered this error through the LaravelLocalizationRoutes middleware, since $routeName = $app['laravellocalization']->getRouteNameFromAPath($request->getUri()); was returning false.

This bug only occurs with routes with parameters.