HasTranslations::translate() - Code Metrics - ahmedash95/laravel-translatable - Measure and Improve Code Quality continuously with Scrutinizer

HasTranslations::translate() A
last analyzed 2016-12-14 11:16 UTC

↳ 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	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 string $key
     * @param string $locale
     *
     * @return mixed
     */
    public function translate($key, $locale = null)
    {
        return $this->getTranslation($key, $locale);
    }

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

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

        $translation = isset($translations[$locale]) ? $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)
    {
        $this->guardAgainstUntranslatableAttribute($key);

        return json_decode(isset($this->getAttributes()[$key]) ? $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($key, $locale, $value)
    {
        $this->guardAgainstUntranslatableAttribute($key);

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

        $oldValue = isset($translations[$locale]) ? $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($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($key, $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($key)
    {
        return array_keys($this->getTranslations($key));
    }

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

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

    protected function normalizeLocale($key, $locale)
    {
        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()
    {
        return is_array($this->translatable)
class MyClass { }

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

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

ahmedash95 / laravel-translatable

HasTranslations::translate() A last analyzed 2016-12-14 11:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HasTranslations::translate() A
last analyzed 2016-12-14 11:16 UTC