HasTranslations - Code Metrics - Inspection of "php 5.6 support" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fd8510...b7d577 )

by Cristian

created 2017-02-13 17:22 UTC

HasTranslations A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	196
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	196
rs	10
c	0
b	0
f	0
wmc	25
lcom	1
cbo	1

9 Methods

Rating	Name	Size	Complexity
A	getCastedAttributes()	4	1
A	getAttributeValue()	10	4
A	create()	19	3
A	update()	20	4
A	translationEnabledForModel()	4	1
A	getAvailableLocales()	4	1
A	setLocale()	4	1
A	getLocale()	8	2
C	__call()	31	8

<?php

namespace Backpack\CRUD\ModelTraits\SpatieTranslatable;

use Spatie\Translatable\HasTranslations as OriginalHasTranslations;

trait HasTranslations
{
    use OriginalHasTranslations;

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


    /**
     * Get the attributes that were casted in the model.
     * Used for translations because Spatie/Laravel-Translatable
     * overwrites the getCasts() method.
     *
     * @return [type] [description]

     */
    public function getCastedAttributes() : array
    {
        return parent::getCasts();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /*
    |--------------------------------------------------------------------------
    |                 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'));

        return is_array($translation) ? array_first($translation) : $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']);

        $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'] ?? \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;
            }
        }

        return $this->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) {
                        $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			* Get the attributes that were casted in the model.
19			* Used for translations because Spatie/Laravel-Translatable
20			* overwrites the getCasts() method.
21			*
22			* @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...
23			*/
24			public function getCastedAttributes() : array
25			{
26			return parent::getCasts();
			0 ignored issues – show Comprehensibility Bug introduced 2016-12-23 13:37 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getCasts()` instead of `getCastedAttributes()`). Are you sure this is correct? If so, you might want to change this to `$this->getCasts()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
27			}
28
29			/*
30			\|--------------------------------------------------------------------------
31			\| SPATIE/LARAVEL-TRANSLATABLE OVERWRITES
32			\|--------------------------------------------------------------------------
33			*/
34
35			/**
36			* Use the forced locale if present.
37			*
38			* @param string $key
39			* @return mixed
40			*/
41			public function getAttributeValue($key)
42			{
43			if (! $this->isTranslatableAttribute($key)) {
44			return parent::getAttributeValue($key);
45			}
46
47			$translation = $this->getTranslation($key, $this->locale ?: config('app.locale'));
48
49			return is_array($translation) ? array_first($translation) : $translation;
50			}
51
52			/*
53			\|--------------------------------------------------------------------------
54			\| ELOQUENT OVERWRITES
55			\|--------------------------------------------------------------------------
56			*/
57
58			/**
59			* Create translated items as json.
60			*
61			* @param array $attributes
62			* @return static
63			*/
64			public static function create(array $attributes = [])
65			{
66			$locale = $attributes['locale'] ?? \App::getLocale();
67			$attributes = array_except($attributes, ['locale']);
68
69			$model = new static();
70
71			// do the actual saving
72			foreach ($attributes as $attribute => $value) {
73			if ($model->isTranslatableAttribute($attribute)) { // the attribute is translatable
74			$model->setTranslation($attribute, $locale, $value);
75			} else { // the attribute is NOT translatable
76			$model->{$attribute} = $value;
77			}
78			}
79			$model->save();
80
81			return $model;
82			}
83
84			/**
85			* Update translated items as json.
86			*
87			* @param array $attributes
88			* @param array $options
89			* @return bool
90			*/
91			public function update(array $attributes = [], array $options = [])
92			{
93			if (! $this->exists) {
94			return false;
95			}
96
97			$locale = $attributes['locale'] ?? \App::getLocale();
98			$attributes = array_except($attributes, ['locale']);
99
100			// do the actual saving
101			foreach ($attributes as $attribute => $value) {
102			if ($this->isTranslatableAttribute($attribute)) { // the attribute is translatable
103			$this->setTranslation($attribute, $locale, $value);
104			} else { // the attribute is NOT translatable
105			$this->{$attribute} = $value;
106			}
107			}
108
109			return $this->save($options);
110			}
111
112			/*
113			\|--------------------------------------------------------------------------
114			\| CUSTOM METHODS
115			\|--------------------------------------------------------------------------
116			*/
117
118			/**
119			* Check if a model is translatable, by the adapter's standards.
120			*
121			* @return bool
122			*/
123			public function translationEnabledForModel()
124			{
125			return property_exists($this, 'translatable');
126			}
127
128			/**
129			* Get all locales the admin is allowed to use.
130			*
131			* @return array
132			*/
133			public function getAvailableLocales()
134			{
135			return config('backpack.crud.locales');
136			}
137
138			/**
139			* Set the locale property. Used in normalizeLocale() to force the translation
140			* to a different language that the one set in app()->getLocale();.
141			*
142			* @param string
143			*/
144			public function setLocale($locale)
145			{
146			$this->locale = $locale;
147			}
148
149			/**
150			* Get the locale property. Used in SpatieTranslatableSluggableService
151			* to save the slug for the appropriate language.
152			*
153			* @param string
154			*/
155			public function getLocale()
			0 ignored issues – show Documentation introduced 2017-01-23 12:15 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...
156			{
157			if ($this->locale) {
158			return $this->locale;
159			}
160
161			return \Request::input('locale', \App::getLocale());
162			}
163
164			/**
165			* Magic method to get the db entries already translated in the wanted locale.
166			*
167			* @param string $method
168			* @param array $parameters
169			* @return
170			*/
171			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...
172			{
173			switch ($method) {
174			// translate all find methods
175			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...
176			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...
177			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...
178			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...
179			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...
180
181			$translation_locale = \Request::input('locale', \App::getLocale());
182
183			if ($translation_locale) {
184			$item = parent::__call($method, $parameters);
185
186			if ($item) {
187			$item->setLocale($translation_locale);
188			}
189
190			return $item;
191			}
192
193			return parent::__call($method, $parameters);
194			break;
			0 ignored issues – show Unused Code introduced 2017-02-13 17:25 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...
195
196			// do not translate any other methods
197			default:
198			return parent::__call($method, $parameters);
199			break;
			0 ignored issues – show Unused Code introduced 2017-02-13 17:25 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...
200			}
201			}
202			}
203

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Push — master ( fd8510...b7d577 )

HasTranslations A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

Duplication Side-by-Side

Filter issues like