HasTranslations::toArray() - Code Metrics - Inspection of "Return translated values when calling ToArray() on..." - spatie/laravel-translatable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#49)

unknown

created 2017-06-02 11:51 UTC

HasTranslations::toArray() A

↳ Parent: HasTranslations

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
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, config('app.locale'));
    }

    /**
     * @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';
            $value = $this->{$method}($value);
        }

        $translations[$locale] = $value;

        $this->attributes[$key] = $this->asJson($translations);
class MyClass { }

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

        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);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }

    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('laravel-translatable.fallback_locale'))) {
            return $fallbackLocale;
        }

        return $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')
        );
    }

    /**
     * Convert the model instance to an array.
     *
     * @return array
     */
    public function toArray()
    {
        $attributes = parent::toArray();

        foreach ($this->getTranslatableAttributes() as $field) {
            $attributes[$field] = $this->getTranslation($field, config('app.locale'));
        }

        return $attributes;
    }
}


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, config('app.locale'));
23			}
24
25			/**
26			* @param string $key
27			* @param string $locale
28			*
29			* @return mixed
30			*/
31			public function translate(string $key, string $locale = '')
32			{
33			return $this->getTranslation($key, $locale);
34			}
35
36			/***
37			* @param string $key
38			* @param string $locale
39			* @param bool $useFallbackLocale
40			*
41			* @return mixed
42			*/
43			public function getTranslation(string $key, string $locale, bool $useFallbackLocale = true)
44			{
45			$locale = $this->normalizeLocale($key, $locale, $useFallbackLocale);
46
47			$translations = $this->getTranslations($key);
48
49			$translation = $translations[$locale] ?? '';
50
51			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...
52			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...
53			}
54
55			return $translation;
56			}
57
58			public function getTranslationWithFallback(string $key, string $locale)
59			{
60			return $this->getTranslation($key, $locale, true);
61			}
62
63			public function getTranslationWithoutFallback(string $key, string $locale)
64			{
65			return $this->getTranslation($key, $locale, false);
66			}
67
68			public function getTranslations($key) : array
69			{
70			$this->guardAgainstUntranslatableAttribute($key);
71
72			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...
73			}
74
75			/**
76			* @param string $key
77			* @param string $locale
78			* @param $value
79			*
80			* @return $this
81			*/
82			public function setTranslation(string $key, string $locale, $value)
83			{
84			$this->guardAgainstUntranslatableAttribute($key);
85
86			$translations = $this->getTranslations($key);
87
88			$oldValue = $translations[$locale] ?? '';
89
90			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...
91			$method = 'set'.Str::studly($key).'Attribute';
92			$value = $this->{$method}($value);
93			}
94
95			$translations[$locale] = $value;
96
97			$this->attributes[$key] = $this->asJson($translations);
			0 ignored issues – show Bug introduced 2016-04-11 14:45 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... 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...
98
99			event(new TranslationHasBeenSet($this, $key, $locale, $oldValue, $value));
100
101			return $this;
102			}
103
104			/**
105			* @param string $key
106			* @param array $translations
107			*
108			* @return $this
109			*/
110			public function setTranslations(string $key, array $translations)
111			{
112			$this->guardAgainstUntranslatableAttribute($key);
113
114			foreach ($translations as $locale => $translation) {
115			$this->setTranslation($key, $locale, $translation);
116			}
117
118			return $this;
119			}
120
121			/**
122			* @param string $key
123			* @param string $locale
124			*
125			* @return $this
126			*/
127			public function forgetTranslation(string $key, string $locale)
128			{
129			$translations = $this->getTranslations($key);
130
131			unset($translations[$locale]);
132
133			$this->setAttribute($key, $translations);
			0 ignored issues – show Bug introduced 2016-04-07 22:25 UTC by Report Bug Copy Issue Report It seems like `setAttribute()` 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...
134
135			return $this;
136			}
137
138			public function getTranslatedLocales(string $key) : array
139			{
140			return array_keys($this->getTranslations($key));
141			}
142
143			public function isTranslatableAttribute(string $key) : bool
144			{
145			return in_array($key, $this->getTranslatableAttributes());
146			}
147
148			protected function guardAgainstUntranslatableAttribute(string $key)
149			{
150			if (!$this->isTranslatableAttribute($key)) {
151			throw AttributeIsNotTranslatable::make($key, $this);
152			}
153			}
154
155			protected function normalizeLocale(string $key, string $locale, bool $useFallbackLocale) : string
156			{
157			if (in_array($locale, $this->getTranslatedLocales($key))) {
158			return $locale;
159			}
160
161			if (!$useFallbackLocale) {
162			return $locale;
163			}
164
165			if (!is_null($fallbackLocale = config('laravel-translatable.fallback_locale'))) {
166			return $fallbackLocale;
167			}
168
169			return $locale;
170			}
171
172			public function getTranslatableAttributes() : array
173			{
174			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...
175			? $this->translatable
176			: [];
177			}
178
179			public function getCasts() : array
180			{
181			return array_merge(
182			parent::getCasts(),
183			array_fill_keys($this->getTranslatableAttributes(), 'array')
184			);
185			}
186
187			/**
188			* Convert the model instance to an array.
189			*
190			* @return array
191			*/
192			public function toArray()
193			{
194			$attributes = parent::toArray();
195
196			foreach ($this->getTranslatableAttributes() as $field) {
197			$attributes[$field] = $this->getTranslation($field, config('app.locale'));
198			}
199
200			return $attributes;
201			}
202			}
203

spatie / laravel-translatable

Pull Request — master (#49)

HasTranslations::toArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like