HasTranslations - Code Metrics - Inspection of "Fix #1321" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1330)

by Oliver

created 2018-04-10 08:07 UTC

HasTranslations A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	194
Duplicated Lines	7.22 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	14
loc	194
rs	10
c	0
b	0
f	0
wmc	26
lcom	1
cbo	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getAttributeValue()	0	15	4
A	translationEnabledForModel()	0	4	1
A	getAvailableLocales()	0	4	1
A	setLocale()	0	4	1
A	getLocale()	0	8	2
A	create()	7	20	3
A	update()	7	21	4
D	__call()	0	35	10

How to fix Duplicated Code

<?php

namespace Backpack\CRUD\ModelTraits\SpatieTranslatable;

use Spatie\Translatable\HasTranslations as OriginalHasTranslations;

trait HasTranslations
{
    use OriginalHasTranslations;

    /**
     * @var bool
     */
    public $locale = false;

    /*
    |--------------------------------------------------------------------------
    |                 SPATIE/LARAVEL-TRANSLATABLE OVERWRITES
    |--------------------------------------------------------------------------
    */

    /**
     * Use the forced locale if present.
     *
     * @param string $key
     * @return mixed
     */
    public function getAttributeValue($key)
    {
        if (! $this->isTranslatableAttribute($key)) {
            return parent::getAttributeValue($key);
        }

        $translation = $this->getTranslation($key, $this->locale ?: config('app.locale'));

        // if it's a fake field, json_encode it
        if (is_array($translation)) {
            return json_encode($translation);
        }

        return $translation;
    }

    /*
    |--------------------------------------------------------------------------
    |                            ELOQUENT OVERWRITES
    |--------------------------------------------------------------------------
    */

    /**
     * Create translated items as json.
     *
     * @param array $attributes
     * @return static
     */
    public static function create(array $attributes = [])
    {
        $locale = $attributes['locale'] ?? \App::getLocale();
        $attributes = array_except($attributes, ['locale']);
        $non_translatable = [];

        $model = new static();

        // do the actual saving
        foreach ($attributes as $attribute => $value) {

            if ($model->isTranslatableAttribute($attribute)) { // the attribute is translatable
                $model->setTranslation($attribute, $locale, $value);
            } else { // the attribute is NOT translatable
                $non_translatable[$attribute] = $value;
            }
        }
        $model->fill($non_translatable)->save();

        return $model;
    }

    /**
     * Update translated items as json.
     *
     * @param array $attributes
     * @param array $options
     * @return bool
     */
    public function update(array $attributes = [], array $options = [])
    {
        if (! $this->exists) {
            return false;
        }

        $locale = $attributes['locale'] ?? \App::getLocale();
        $attributes = array_except($attributes, ['locale']);
        $non_translatable = [];

        // do the actual saving
        foreach ($attributes as $attribute => $value) {

            if ($this->isTranslatableAttribute($attribute)) { // the attribute is translatable
                $this->setTranslation($attribute, $locale, $value);
            } else { // the attribute is NOT translatable
                $non_translatable[$attribute] = $value;
            }
        }

        return $this->fill($non_translatable)->save($options);
    }

    /*
    |--------------------------------------------------------------------------
    |                            CUSTOM METHODS
    |--------------------------------------------------------------------------
    */

    /**
     * Check if a model is translatable, by the adapter's standards.
     *
     * @return bool
     */
    public function translationEnabledForModel()
    {
        return property_exists($this, 'translatable');
    }

    /**
     * Get all locales the admin is allowed to use.
     *
     * @return array
     */
    public function getAvailableLocales()
    {
        return config('backpack.crud.locales');
    }

    /**
     * Set the locale property. Used in normalizeLocale() to force the translation
     * to a different language that the one set in app()->getLocale();.
     *
     * @param string
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;
    }

    /**
     * Get the locale property. Used in SpatieTranslatableSluggableService
     * to save the slug for the appropriate language.
     *
     * @param string
     */
    public function getLocale()

    {
        if ($this->locale) {
            return $this->locale;
        }

        return \Request::input('locale', \App::getLocale());
    }

    /**
     * Magic method to get the db entries already translated in the wanted locale.
     *
     * @param string $method
     * @param array $parameters
     * @return
     */
    public function __call($method, $parameters)

    {
        switch ($method) {
            // translate all find methods
            case 'find':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            case 'findOrFail':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            case 'findMany':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            case 'findBySlug':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
            case 'findBySlugOrFail':
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

                $translation_locale = \Request::input('locale', \App::getLocale());

                if ($translation_locale) {
                    $item = parent::__call($method, $parameters);

                    if ($item instanceof \Traversable) {
                        foreach ($item as $instance) {
                            $instance->setLocale($translation_locale);
                        }
                    } elseif ($item) {
                        $item->setLocale($translation_locale);
                    }

                    return $item;
                }

                return parent::__call($method, $parameters);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            // do not translate any other methods
            default:
                return parent::__call($method, $parameters);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
    }
}


1		<?php
2
3		namespace Backpack\CRUD\ModelTraits\SpatieTranslatable;
4
5		use Spatie\Translatable\HasTranslations as OriginalHasTranslations;
6
7		trait HasTranslations
8		{
9		use OriginalHasTranslations;
10
11		/**
12		* @var bool
13		*/
14		public $locale = false;
15
16		/*
17		\|--------------------------------------------------------------------------
18		\| SPATIE/LARAVEL-TRANSLATABLE OVERWRITES
19		\|--------------------------------------------------------------------------
20		*/
21
22		/**
23		* Use the forced locale if present.
24		*
25		* @param string $key
26		* @return mixed
27		*/
28		public function getAttributeValue($key)
29		{
30		if (! $this->isTranslatableAttribute($key)) {
31		return parent::getAttributeValue($key);
32		}
33
34		$translation = $this->getTranslation($key, $this->locale ?: config('app.locale'));
35
36		// if it's a fake field, json_encode it
37		if (is_array($translation)) {
38		return json_encode($translation);
39		}
40
41		return $translation;
42		}
43
44		/*
45		\|--------------------------------------------------------------------------
46		\| ELOQUENT OVERWRITES
47		\|--------------------------------------------------------------------------
48		*/
49
50		/**
51		* Create translated items as json.
52		*
53		* @param array $attributes
54		* @return static
55		*/
56		public static function create(array $attributes = [])
57		{
58		$locale = $attributes['locale'] ?? \App::getLocale();
59		$attributes = array_except($attributes, ['locale']);
60		$non_translatable = [];
61
62		$model = new static();
63
64		// do the actual saving
65	View Code Duplication	foreach ($attributes as $attribute => $value) {
		0 ignored issues – show Duplication introduced 2017-06-22 11:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
66		if ($model->isTranslatableAttribute($attribute)) { // the attribute is translatable
67		$model->setTranslation($attribute, $locale, $value);
68		} else { // the attribute is NOT translatable
69		$non_translatable[$attribute] = $value;
70		}
71		}
72		$model->fill($non_translatable)->save();
73
74		return $model;
75		}
76
77		/**
78		* Update translated items as json.
79		*
80		* @param array $attributes
81		* @param array $options
82		* @return bool
83		*/
84		public function update(array $attributes = [], array $options = [])
85		{
86		if (! $this->exists) {
87		return false;
88		}
89
90		$locale = $attributes['locale'] ?? \App::getLocale();
91		$attributes = array_except($attributes, ['locale']);
92		$non_translatable = [];
93
94		// do the actual saving
95	View Code Duplication	foreach ($attributes as $attribute => $value) {
		0 ignored issues – show Duplication introduced 2017-06-22 11:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
96		if ($this->isTranslatableAttribute($attribute)) { // the attribute is translatable
97		$this->setTranslation($attribute, $locale, $value);
98		} else { // the attribute is NOT translatable
99		$non_translatable[$attribute] = $value;
100		}
101		}
102
103		return $this->fill($non_translatable)->save($options);
104		}
105
106		/*
107		\|--------------------------------------------------------------------------
108		\| CUSTOM METHODS
109		\|--------------------------------------------------------------------------
110		*/
111
112		/**
113		* Check if a model is translatable, by the adapter's standards.
114		*
115		* @return bool
116		*/
117		public function translationEnabledForModel()
118		{
119		return property_exists($this, 'translatable');
120		}
121
122		/**
123		* Get all locales the admin is allowed to use.
124		*
125		* @return array
126		*/
127		public function getAvailableLocales()
128		{
129		return config('backpack.crud.locales');
130		}
131
132		/**
133		* Set the locale property. Used in normalizeLocale() to force the translation
134		* to a different language that the one set in app()->getLocale();.
135		*
136		* @param string
137		*/
138		public function setLocale($locale)
139		{
140		$this->locale = $locale;
141		}
142
143		/**
144		* Get the locale property. Used in SpatieTranslatableSluggableService
145		* to save the slug for the appropriate language.
146		*
147		* @param string
148		*/
149		public function getLocale()
		0 ignored issues – show Documentation introduced 2017-08-03 17:04 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
150		{
151		if ($this->locale) {
152		return $this->locale;
153		}
154
155		return \Request::input('locale', \App::getLocale());
156		}
157
158		/**
159		* Magic method to get the db entries already translated in the wanted locale.
160		*
161		* @param string $method
162		* @param array $parameters
163		* @return
164		*/
165		public function __call($method, $parameters)
		0 ignored issues – show Documentation introduced 2017-08-03 17:04 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
166		{
167		switch ($method) {
168		// translate all find methods
169		case 'find':
		0 ignored issues – show Coding Style introduced 2017-01-06 10:05 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
170		case 'findOrFail':
		0 ignored issues – show Coding Style introduced 2017-01-06 10:05 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
171		case 'findMany':
		0 ignored issues – show Coding Style introduced 2017-01-23 12:15 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
172		case 'findBySlug':
		0 ignored issues – show Coding Style introduced 2017-01-23 12:15 UTC by Report Bug Copy Issue Report `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
173		case 'findBySlugOrFail':
		0 ignored issues – show Coding Style introduced 2017-01-23 12:15 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
174
175		$translation_locale = \Request::input('locale', \App::getLocale());
176
177		if ($translation_locale) {
178		$item = parent::__call($method, $parameters);
179
180		if ($item instanceof \Traversable) {
181		foreach ($item as $instance) {
182		$instance->setLocale($translation_locale);
183		}
184		} elseif ($item) {
185		$item->setLocale($translation_locale);
186		}
187
188		return $item;
189		}
190
191		return parent::__call($method, $parameters);
192		break;
		0 ignored issues – show Unused Code introduced 2017-02-14 09:27 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
193
194		// do not translate any other methods
195		default:
196		return parent::__call($method, $parameters);
197		break;
		0 ignored issues – show Unused Code introduced 2017-02-14 09:27 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
198		}
199		}
200		}
201

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#1330)

HasTranslations A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like