HasTranslations::forgetTranslation() - Code Metrics - Inspection of "Handle attribute set in all scenarios" - spatie/laravel-translatable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#11)

unknown

created 2016-06-13 11:36 UTC

HasTranslations::forgetTranslation() A

↳ Parent: HasTranslations

Complexity

Conditions	1
Paths	1

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	1
eloc	5
nc	1
nop	2

<?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 $key
	 * @param $value
	 *
	 * @return $this
	 */
    public function setAttribute($key, $value)
    {
        if (!$this->isTranslatableAttribute($key)) {
            return parent::setAttribute($key, $value);
        }

        if (is_string($value) && !json_decode($value))
        {
            return $this->setTranslation($key, config('app.locale'), $value);
        }
	    
	    if(is_string($value) && json_decode($value)) {
            return $this->setTranslations($key, json_decode($value, true));
        }
        
        return $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
     *
     * @return mixed
     */
    public function getTranslation(string $key, string $locale)
    {
        $locale = $this->normalizeLocale($key, $locale);

        $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 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);

        return $this;
    }

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

    protected 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) : string
    {
        if (in_array($locale, $this->getTranslatedLocales($key))) {
            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')
        );
    }
}


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

spatie / laravel-translatable

Pull Request — master (#11)

HasTranslations::forgetTranslation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like