SpatieTranslatableAdaptor - Code Metrics - Inspection of "Multilanguage with spatie/laravel-translatable" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#317)

by Cristian

created 2017-01-06 10:02 UTC

SpatieTranslatableAdaptor A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	20
lcom	1
cbo	1
dl	0
loc	157
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	getAttributeValue()	10	4
A	create()	19	3
B	update()	21	5
A	translationEnabledForModel()	4	1
A	getAvailableLocales()	4	1
A	setLocale()	4	1
B	__call()	27	5

<?php

namespace Backpack\CRUD\ModelTraits\Translatable;

use Spatie\Translatable\HasTranslations;

trait SpatieTranslatableAdaptor
{
    use HasTranslations;

    public $locale = false;

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

    /**
     * Use the forced locale if present.
     *
     * @param  [type] $key [description]

     * @return [type]      [description]

     */
    public function getAttributeValue($key)
    {
        if (! $this->isTranslatableAttribute($key)) {
            return parent::getAttributeValue($key);
        }

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

        return is_array($translation) ? array_first($translation) : $translation;
    }

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

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

        $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
                $model->{$attribute} = $value;
            }
        }
        $model->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'] ? $attributes['locale'] : App::getLocale();
        $attributes = array_except($attributes, ['locale']);

        // 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
                $this->{$attribute} = $value;
            }
        }
        $this->save($options);

        return $this;
    }

    /*
    |--------------------------------------------------------------------------
    |                            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;
    }

    /**
     * Magic method to get the db entries already translated in the wanted locale.
     */
    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":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

                $translation_locale = \Request::input('locale');
                $default_locale = \App::getLocale();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

                if ($translation_locale) {
                    $item = parent::__call($method, $parameters);
                    $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\Translatable;
4
5			use Spatie\Translatable\HasTranslations;
6
7			trait SpatieTranslatableAdaptor
8			{
9			use HasTranslations;
10
11			public $locale = false;
12
13			/*
14			\|--------------------------------------------------------------------------
15			\| SPATIE/LARAVEL-TRANSLATABLE OVERWRITES
16			\|--------------------------------------------------------------------------
17			*/
18
19			/**
20			* Use the forced locale if present.
21			*
22			* @param [type] $key [description]
			0 ignored issues – show Documentation introduced 2016-12-23 13:37 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
23			* @return [type] [description]
			0 ignored issues – show Documentation introduced 2016-12-23 13:37 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
24			*/
25			public function getAttributeValue($key)
26			{
27			if (! $this->isTranslatableAttribute($key)) {
28			return parent::getAttributeValue($key);
29			}
30
31			$translation = $this->getTranslation($key, $this->locale ?: config('app.locale'));
32
33			return is_array($translation) ? array_first($translation) : $translation;
34			}
35
36			/*
37			\|--------------------------------------------------------------------------
38			\| ELOQUENT OVERWRITES
39			\|--------------------------------------------------------------------------
40			*/
41
42			/**
43			* Create translated items as json.
44			*
45			* @param array $attributes [description]
46			*/
47			public static function create(array $attributes = [])
48			{
49			$locale = $attributes['locale'] ?? \App::getLocale();
50			$attributes = array_except($attributes, ['locale']);
51
52			$model = new static();
53
54			// do the actual saving
55			foreach ($attributes as $attribute => $value) {
56			if ($model->isTranslatableAttribute($attribute)) { // the attribute is translatable
57			$model->setTranslation($attribute, $locale, $value);
58			} else { // the attribute is NOT translatable
59			$model->{$attribute} = $value;
60			}
61			}
62			$model->save();
63
64			return $model;
65			}
66
67			/**
68			* Update translated items as json.
69			*
70			* @param array $attributes
71			* @param array $options
72			* @return bool
			0 ignored issues – show Documentation introduced 2016-12-23 13:37 UTC by Report Bug Copy Issue Report Should the return type not be `false\|SpatieTranslatableAdaptor`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
73			*/
74			public function update(array $attributes = [], array $options = [])
75			{
76			if (! $this->exists) {
77			return false;
78			}
79
80			$locale = $attributes['locale'] ? $attributes['locale'] : App::getLocale();
81			$attributes = array_except($attributes, ['locale']);
82
83			// do the actual saving
84			foreach ($attributes as $attribute => $value) {
85			if ($this->isTranslatableAttribute($attribute)) { // the attribute is translatable
86			$this->setTranslation($attribute, $locale, $value);
87			} else { // the attribute is NOT translatable
88			$this->{$attribute} = $value;
89			}
90			}
91			$this->save($options);
92
93			return $this;
94			}
95
96			/*
97			\|--------------------------------------------------------------------------
98			\| CUSTOM METHODS
99			\|--------------------------------------------------------------------------
100			*/
101
102			/**
103			* Check if a model is translatable, by the adapter's standards.
104			*
105			* @return bool
106			*/
107			public function translationEnabledForModel()
108			{
109			return property_exists($this, 'translatable');
110			}
111
112			/**
113			* Get all locales the admin is allowed to use.
114			*
115			* @return array
116			*/
117			public function getAvailableLocales()
118			{
119			return config('backpack.crud.locales');
120			}
121
122			/**
123			* Set the locale property. Used in normalizeLocale() to force the translation
124			* to a different language that the one set in app()->getLocale();.
125			*
126			* @param string
127			*/
128			public function setLocale($locale)
129			{
130			$this->locale = $locale;
131			}
132
133			/**
134			* Magic method to get the db entries already translated in the wanted locale.
135			*/
136			public function __call($method, $parameters)
			0 ignored issues – show Documentation introduced 2017-01-06 10:05 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...
137			{
138			switch ($method) {
139			// translate all find methods
140			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...
141			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...
142			case 'findMany':
			0 ignored issues – show Coding Style introduced 2017-01-06 10:05 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...
143
144			$translation_locale = \Request::input('locale');
145			$default_locale = \App::getLocale();
			0 ignored issues – show Unused Code introduced 2016-12-23 13:37 UTC by Report Bug Copy Issue Report `$default_locale` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
146
147			if ($translation_locale) {
148			$item = parent::__call($method, $parameters);
149			$item->setLocale($translation_locale);
150
151			return $item;
152			}
153
154			return parent::__call($method, $parameters);
155			break;
			0 ignored issues – show Unused Code introduced 2017-01-06 10:08 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...
156
157			// do not translate any other methods
158			default:
159			return parent::__call($method, $parameters);
160			break;
			0 ignored issues – show Unused Code introduced 2017-01-06 10:08 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...
161			}
162			}
163			}
164

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#317)

SpatieTranslatableAdaptor A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like