LoadsTranslatedCachedRoutes::loadCachedRoutes() - Code Metrics - Inspection of "refer to issue #15" - richan-fongdasen/laravel-i18n - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

unknown

created 2020-01-18 16:18 UTC

LoadsTranslatedCachedRoutes::loadCachedRoutes() A

↳ Parent: LoadsTranslatedCachedRoutes

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	9.552
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

namespace RichanFongdasen\I18n\Traits;

use Illuminate\Support\Facades\Log;
use RichanFongdasen\I18n\I18nService;

/**
 * LoadsTranslatedCachedRoutes.
 *
 * Add this trait to your App\RouteServiceProvider to load
 * translated cached routes for the active locale, instead
 * of the default locale's routes (irrespective of active).
 */
trait LoadsTranslatedCachedRoutes
{
    /**
     * Catch your Http Request.
     *
     * @var Illuminate\Http\Request
     */
    protected $request;

    /**
     * Load the cached routes for the application.
     *
     * @return void
     */
    protected function loadCachedRoutes()
    {
        $localization = $this->getI18nService();

        $locale = $localization->routePrefix();

        // First, try to load the routes specifically cached for this locale
        // if they do not exist, write a warning to the log and load the default
        // routes instead. Note that this is guaranteed to exist, because the
        // 'cached routes' check in the Application checks its existence.

        $path = $this->makeLocaleRoutesPath($locale);

        if (!file_exists($path)) {
            Log::warning("Routes cached, but no cached routes found for locale '{$locale}'!");

            $path = $this->getDefaultCachedRoutePath();
        }

        $this->app->booted(function () use ($path) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            require $path;
        });
    }

    /**
     * Returns the path to the cached routes file for a given locale.
     *
     * @param string|null $locale
     *
     * @return string
     */
    protected function makeLocaleRoutesPath($locale = null)

    {
        $path = $this->getDefaultCachedRoutePath();
        if ($locale === null) {
            return $path;
        }

        return substr($path, 0, -4).'_'.$locale.'.php';
    }

    /**
     * Returns the path to the standard cached routes file.
     *
     * @return string
     */
    protected function getDefaultCachedRoutePath()
    {
        return $this->app->getCachedRoutesPath();
    }

    /**
     * @return \RichanFongdasen\I18n\I18nService
     */
    protected function getI18nService()
    {
        return new I18nService($this->request);
    }
}


1		<?php
2
3		namespace RichanFongdasen\I18n\Traits;
4
5		use Illuminate\Support\Facades\Log;
6		use RichanFongdasen\I18n\I18nService;
7
8		/**
9		* LoadsTranslatedCachedRoutes.
10		*
11		* Add this trait to your App\RouteServiceProvider to load
12		* translated cached routes for the active locale, instead
13		* of the default locale's routes (irrespective of active).
14		*/
15		trait LoadsTranslatedCachedRoutes
16		{
17		/**
18		* Catch your Http Request.
19		*
20		* @var Illuminate\Http\Request
21		*/
22		protected $request;
23
24		/**
25		* Load the cached routes for the application.
26		*
27		* @return void
28		*/
29		protected function loadCachedRoutes()
30		{
31		$localization = $this->getI18nService();
32
33		$locale = $localization->routePrefix();
34
35		// First, try to load the routes specifically cached for this locale
36		// if they do not exist, write a warning to the log and load the default
37		// routes instead. Note that this is guaranteed to exist, because the
38		// 'cached routes' check in the Application checks its existence.
39
40		$path = $this->makeLocaleRoutesPath($locale);
41
42		if (!file_exists($path)) {
43		Log::warning("Routes cached, but no cached routes found for locale '{$locale}'!");
44
45		$path = $this->getDefaultCachedRoutePath();
46		}
47
48		$this->app->booted(function () use ($path) {
		0 ignored issues – show Bug introduced 2020-01-16 10:23 UTC by Report Bug Copy Issue Report The property `app` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
49		require $path;
50		});
51		}
52
53		/**
54		* Returns the path to the cached routes file for a given locale.
55		*
56		* @param string\|null $locale
57		*
58		* @return string
59		*/
60	View Code Duplication	protected function makeLocaleRoutesPath($locale = null)
		0 ignored issues – show Duplication introduced 2020-01-16 10:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61		{
62		$path = $this->getDefaultCachedRoutePath();
63		if ($locale === null) {
64		return $path;
65		}
66
67		return substr($path, 0, -4).'_'.$locale.'.php';
68		}
69
70		/**
71		* Returns the path to the standard cached routes file.
72		*
73		* @return string
74		*/
75		protected function getDefaultCachedRoutePath()
76		{
77		return $this->app->getCachedRoutesPath();
78		}
79
80		/**
81		* @return \RichanFongdasen\I18n\I18nService
82		*/
83		protected function getI18nService()
84		{
85		return new I18nService($this->request);
86		}
87		}
88

richan-fongdasen / laravel-i18n

Pull Request — master (#16)

LoadsTranslatedCachedRoutes::loadCachedRoutes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like