HasTranslations::getLocale() - Code Metrics - Inspection of "Replace config('app.locale') with getLocale() (#10..." - spatie/laravel-translatable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 302595...5b8169 )

by Freek

created 2018-01-24 14:47 UTC

HasTranslations::getLocale() A

↳ Parent: HasTranslations

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Spatie\Translatable;

use Illuminate\Support\Str;
use Spatie\Translatable\Events\TranslationHasBeenSet;
use Spatie\Translatable\Exceptions\AttributeIsNotTranslatable;

trait HasTranslations
{
    /**
     * @param string $key
     *
     * @return mixed
     */
    public function getAttributeValue($key)
    {
        if (!$this->isTranslatableAttribute($key)) {
            return parent::getAttributeValue($key);
        }

        return $this->getTranslation($key, $this->getLocale());
    }

    /**
     * Set a given attribute on the model.
     *
     * @param string $key
     * @param mixed  $value
     *
     * @return $this
     */
    public function setAttribute($key, $value)
    {
        // pass arrays and untranslatable attributes to the parent method
        if (!$this->isTranslatableAttribute($key) || is_array($value)) {
            return parent::setAttribute($key, $value);
        }
        // if the attribute is translatable and not already translated (=array),
        // set a translation for the current app locale
        return $this->setTranslation($key, $this->getLocale(), $value);
    }

    /**
     * @param string $key
     * @param string $locale
     *
     * @return mixed
     */
    public function translate(string $key, string $locale = '')
    {
        return $this->getTranslation($key, $locale);
    }

    /***
     * @param string $key
     * @param string $locale
     * @param bool $useFallbackLocale
     *
     * @return mixed
     */
    public function getTranslation(string $key, string $locale, bool $useFallbackLocale = true)
    {
        $locale = $this->normalizeLocale($key, $locale, $useFallbackLocale);

        $translations = $this->getTranslations($key);

        $translation = $translations[$locale] ?? '';

        if ($this->hasGetMutator($key)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            return $this->mutateAttribute($key, $translation);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $translation;
    }

    public function getTranslationWithFallback(string $key, string $locale)
    {
        return $this->getTranslation($key, $locale, true);
    }

    public function getTranslationWithoutFallback(string $key, string $locale)
    {
        return $this->getTranslation($key, $locale, false);
    }

    public function getTranslations($key) : array
    {
        $this->guardAgainstUntranslatableAttribute($key);

        return json_decode($this->getAttributes()[$key] ?? '' ?: '{}', true);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @param string $key
     * @param string $locale
     * @param $value
     *
     * @return $this
     */
    public function setTranslation(string $key, string $locale, $value)
    {
        $this->guardAgainstUntranslatableAttribute($key);

        $translations = $this->getTranslations($key);

        $oldValue = $translations[$locale] ?? '';

        if ($this->hasSetMutator($key)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $method = 'set'.Str::studly($key).'Attribute';
            $this->{$method}($value, $locale);
            $value = $this->attributes[$key];
class MyClass { }

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

        $translations[$locale] = $value;

        $this->attributes[$key] = $this->asJson($translations);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        event(new TranslationHasBeenSet($this, $key, $locale, $oldValue, $value));

        return $this;
    }

    /**
     * @param string $key
     * @param array  $translations
     *
     * @return $this
     */
    public function setTranslations(string $key, array $translations)
    {
        $this->guardAgainstUntranslatableAttribute($key);

        foreach ($translations as $locale => $translation) {
            $this->setTranslation($key, $locale, $translation);
        }

        return $this;
    }

    /**
     * @param string $key
     * @param string $locale
     *
     * @return $this
     */
    public function forgetTranslation(string $key, string $locale)
    {
        $translations = $this->getTranslations($key);

        unset($translations[$locale]);

        $this->setAttribute($key, $translations);

        return $this;
    }

    public function forgetAllTranslations(string $locale)
    {
        collect($this->getTranslatableAttributes())->each(function (string $attribute) use ($locale) {
            $this->forgetTranslation($attribute, $locale);
        });
    }

    public function getTranslatedLocales(string $key) : array
    {
        return array_keys($this->getTranslations($key));
    }

    public function isTranslatableAttribute(string $key) : bool
    {
        return in_array($key, $this->getTranslatableAttributes());
    }

    protected function guardAgainstUntranslatableAttribute(string $key)
    {
        if (!$this->isTranslatableAttribute($key)) {
            throw AttributeIsNotTranslatable::make($key, $this);
        }
    }

    protected function normalizeLocale(string $key, string $locale, bool $useFallbackLocale) : string
    {
        if (in_array($locale, $this->getTranslatedLocales($key))) {
            return $locale;
        }

        if (!$useFallbackLocale) {
            return $locale;
        }

        if (!is_null($fallbackLocale = config('translatable.fallback_locale'))) {
            return $fallbackLocale;
        }

        return $locale;
    }

    protected function getLocale() : string
    {
        return config('app.locale');
    }

    public function getTranslatableAttributes() : array
    {
        return is_array($this->translatable)
class MyClass { }

$x = new MyClass();
$x->foo = true;
            ? $this->translatable
            : [];
    }

    public function getCasts() : array
    {
        return array_merge(
            parent::getCasts(),
            array_fill_keys($this->getTranslatableAttributes(), 'array')
        );
    }
}


1			<?php
2
3			namespace Spatie\Translatable;
4
5			use Illuminate\Support\Str;
6			use Spatie\Translatable\Events\TranslationHasBeenSet;
7			use Spatie\Translatable\Exceptions\AttributeIsNotTranslatable;
8
9			trait HasTranslations
10			{
11			/**
12			* @param string $key
13			*
14			* @return mixed
15			*/
16			public function getAttributeValue($key)
17			{
18			if (!$this->isTranslatableAttribute($key)) {
19			return parent::getAttributeValue($key);
20			}
21
22			return $this->getTranslation($key, $this->getLocale());
23			}
24
25			/**
26			* Set a given attribute on the model.
27			*
28			* @param string $key
29			* @param mixed $value
30			*
31			* @return $this
32			*/
33			public function setAttribute($key, $value)
34			{
35			// pass arrays and untranslatable attributes to the parent method
36			if (!$this->isTranslatableAttribute($key) \|\| is_array($value)) {
37			return parent::setAttribute($key, $value);
38			}
39			// if the attribute is translatable and not already translated (=array),
40			// set a translation for the current app locale
41			return $this->setTranslation($key, $this->getLocale(), $value);
42			}
43
44			/**
45			* @param string $key
46			* @param string $locale
47			*
48			* @return mixed
49			*/
50			public function translate(string $key, string $locale = '')
51			{
52			return $this->getTranslation($key, $locale);
53			}
54
55			/***
56			* @param string $key
57			* @param string $locale
58			* @param bool $useFallbackLocale
59			*
60			* @return mixed
61			*/
62			public function getTranslation(string $key, string $locale, bool $useFallbackLocale = true)
63			{
64			$locale = $this->normalizeLocale($key, $locale, $useFallbackLocale);
65
66			$translations = $this->getTranslations($key);
67
68			$translation = $translations[$locale] ?? '';
69
70			if ($this->hasGetMutator($key)) {
			0 ignored issues – show Bug introduced 2016-04-11 14:45 UTC by Report Bug Copy Issue Report It seems like `hasGetMutator()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
71			return $this->mutateAttribute($key, $translation);
			0 ignored issues – show Bug introduced 2016-04-11 14:45 UTC by Report Bug Copy Issue Report It seems like `mutateAttribute()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
72			}
73
74			return $translation;
75			}
76
77			public function getTranslationWithFallback(string $key, string $locale)
78			{
79			return $this->getTranslation($key, $locale, true);
80			}
81
82			public function getTranslationWithoutFallback(string $key, string $locale)
83			{
84			return $this->getTranslation($key, $locale, false);
85			}
86
87			public function getTranslations($key) : array
88			{
89			$this->guardAgainstUntranslatableAttribute($key);
90
91			return json_decode($this->getAttributes()[$key] ?? '' ?: '{}', true);
			0 ignored issues – show Bug introduced 2016-04-07 22:25 UTC by Report Bug Copy Issue Report It seems like `getAttributes()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
92			}
93
94			/**
95			* @param string $key
96			* @param string $locale
97			* @param $value
98			*
99			* @return $this
100			*/
101			public function setTranslation(string $key, string $locale, $value)
102			{
103			$this->guardAgainstUntranslatableAttribute($key);
104
105			$translations = $this->getTranslations($key);
106
107			$oldValue = $translations[$locale] ?? '';
108
109			if ($this->hasSetMutator($key)) {
			0 ignored issues – show Bug introduced 2016-04-11 14:45 UTC by Report Bug Copy Issue Report It seems like `hasSetMutator()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
110			$method = 'set'.Str::studly($key).'Attribute';
111			$this->{$method}($value, $locale);
112			$value = $this->attributes[$key];
			0 ignored issues – show Bug introduced 2017-12-19 23:18 UTC by Report Bug Copy Issue Report The property `attributes` 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...
113			}
114
115			$translations[$locale] = $value;
116
117			$this->attributes[$key] = $this->asJson($translations);
			0 ignored issues – show Bug introduced 2016-04-11 14:45 UTC by Report Bug Copy Issue Report It seems like `asJson()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
118
119			event(new TranslationHasBeenSet($this, $key, $locale, $oldValue, $value));
120
121			return $this;
122			}
123
124			/**
125			* @param string $key
126			* @param array $translations
127			*
128			* @return $this
129			*/
130			public function setTranslations(string $key, array $translations)
131			{
132			$this->guardAgainstUntranslatableAttribute($key);
133
134			foreach ($translations as $locale => $translation) {
135			$this->setTranslation($key, $locale, $translation);
136			}
137
138			return $this;
139			}
140
141			/**
142			* @param string $key
143			* @param string $locale
144			*
145			* @return $this
146			*/
147			public function forgetTranslation(string $key, string $locale)
148			{
149			$translations = $this->getTranslations($key);
150
151			unset($translations[$locale]);
152
153			$this->setAttribute($key, $translations);
154
155			return $this;
156			}
157
158			public function forgetAllTranslations(string $locale)
159			{
160			collect($this->getTranslatableAttributes())->each(function (string $attribute) use ($locale) {
161			$this->forgetTranslation($attribute, $locale);
162			});
163			}
164
165			public function getTranslatedLocales(string $key) : array
166			{
167			return array_keys($this->getTranslations($key));
168			}
169
170			public function isTranslatableAttribute(string $key) : bool
171			{
172			return in_array($key, $this->getTranslatableAttributes());
173			}
174
175			protected function guardAgainstUntranslatableAttribute(string $key)
176			{
177			if (!$this->isTranslatableAttribute($key)) {
178			throw AttributeIsNotTranslatable::make($key, $this);
179			}
180			}
181
182			protected function normalizeLocale(string $key, string $locale, bool $useFallbackLocale) : string
183			{
184			if (in_array($locale, $this->getTranslatedLocales($key))) {
185			return $locale;
186			}
187
188			if (!$useFallbackLocale) {
189			return $locale;
190			}
191
192			if (!is_null($fallbackLocale = config('translatable.fallback_locale'))) {
193			return $fallbackLocale;
194			}
195
196			return $locale;
197			}
198
199			protected function getLocale() : string
200			{
201			return config('app.locale');
202			}
203
204			public function getTranslatableAttributes() : array
205			{
206			return is_array($this->translatable)
			0 ignored issues – show Bug introduced 2016-04-11 18:01 UTC by Report Bug Copy Issue Report The property `translatable` 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...
207			? $this->translatable
208			: [];
209			}
210
211			public function getCasts() : array
212			{
213			return array_merge(
214			parent::getCasts(),
215			array_fill_keys($this->getTranslatableAttributes(), 'array')
216			);
217			}
218			}
219

spatie / laravel-translatable

Push — master ( 302595...5b8169 )

HasTranslations::getLocale() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like