ChinLeung\LaravelMultilingualRoutes\MultilingualRegistrar

Complexity

Total Complexity

10

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	register()	0	17	2
A	registerRoute()	0	7	1
A	getRequestMethodFromOptions()	0	4	1
A	generateNameForLocaleFromOptions()	0	12	2
A	generatePrefixForLocale()	0	10	3

<?php

namespace ChinLeung\LaravelMultilingualRoutes;

use Illuminate\Routing\Route;
use Illuminate\Routing\RouteCollection;
use Illuminate\Routing\Router;
use Illuminate\Support\Arr;

class MultilingualRegistrar
{
    /**
     * Constructor of the class.
     *
     * @param  \Illuminate\Routing\Router  $router
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(Router $router)
    {
        $this->router = $router;

The property router does not exist. Did you maybe forget to declare it?

    }

    /**
     * Register the routes.
     *
     * @param  string  $key
     * @param  mixed  $handle
     * @param  array  $locales
     * @param  array  $options
     * @return \Illuminate\Routing\RouteCollection
     */
    public function register(string $key, $handle, array $locales, array $options) : RouteCollection
    {
        $collection = new RouteCollection;

        $method = $this->getRequestMethodFromOptions($options);

        foreach ($locales as $locale) {
            $collection->add(
                $this
                    ->registerRoute($method, $key, $handle, $locale)
                    ->name($this->generateNameForLocaleFromOptions($locale, $key, $options))
                    ->prefix($this->generatePrefixForLocale($locale))
            );
        }

        return $collection;
    }

    /**
     * Register a single route.
     *
     * @param  string  $method
     * @param  string  $key
     * @param  mixed  $handle
     * @param  string  $locale
     * @return \Illuminate\Routing\Route
     */
    protected function registerRoute(string $method, string $key, $handle, string $locale) : Route
    {
        return $this->router->{strtolower($method)}(
            trans("routes.$key", [], $locale),
            $handle
        );
    }

    /**
     * Retrieve the request method from the options.
     *
     * @param  array  $options
     * @return string
     */
    protected function getRequestMethodFromOptions(array $options) : string
    {
        return $options['method'] ?? 'get';
    }

    /**
     * Generate the name of the route based on the options.
     *
     * @param  string  $locale
     * @param  string  $key
     * @param  array  $options
     * @return string
     */
    protected function generateNameForLocaleFromOptions(string $locale, string $key, array $options) : string
    {
        if ($name = Arr::get($options, "names.$locale")) {
            return "$locale.$name";
        }

        return sprintf(
            '%s.%s',
            $locale,
            Arr::get($options, 'name', $key)
        );
    }

    /**
     * Generate the prefix of the route based on the options.
     *
     * @param  string  $locale
     * @return string|null
     */
    protected function generatePrefixForLocale(string $locale) : ?string
    {
        if ($locale != config('app.fallback_locale')) {
            return $locale;
        }

        return config('laravel-multilingual-routes.prefix_fallback')
            ? $locale
            : null;
    }
}