HasTranslations - Code Metrics - Inspection of "Locale-less model queries" - spatie/laravel-translatable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Laurent

created 2016-05-03 13:37 UTC

HasTranslations A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Metric	Value
wmc	31
lcom	1
cbo	3
dl	0
loc	201
rs	9.8

14 Methods

Rating	Name	Size	Complexity
A	getAttributeValue()	8	2
A	translate()	4	1
A	getTranslation()	14	2
A	getTranslations()	6	2
A	setTranslation()	21	2
A	setTranslations()	10	2
A	forgetTranslation()	10	1
A	getTranslatedLocales()	4	1
A	isTranslatableAttribute()	4	1
A	guardAgainstUntranslatableAttribute()	6	2
A	normalizeLocale()	12	3
A	getTranslatableAttributes()	6	2
A	getCasts()	7	1
D	__call()	30	9

<?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
     *
     * @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)) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            return $this->mutateAttribute($key, $translation);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }

        return $translation;
    }

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

        return json_decode($this->getAttributes()[$key] ?? '' ?: '{}', true);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * @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)) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            $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);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

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

    /**
     * Handle dynamic method calls into the model (hook for builder only).
     *
     * @param  string  $method
     * @param  array  $parameters
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        if (in_array($method, ['where', 'orWhere'])) {
            if (in_array($parameters[0], $this->translatable)) {
                $parameters[0] = sprintf('%s->%s', $parameters[0], config('app.locale'));
            }
        } elseif (\Illuminate\Support\Str::startsWith($method, 'where')) {
            $finder = substr($method, 5);
            $segments = preg_split('/(And|Or)(?=[A-Z])/', $finder, -1, PREG_SPLIT_DELIM_CAPTURE);

            $connector = 'And';
            $query = $this->newQuery();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            foreach ($segments as $segment) {
                if ($segment != 'And' && $segment != 'Or') {
                    $method = ($connector == 'And') ? 'where' : 'orWhere';
                    $column = snake_case($segment);
                    if (in_array($column, $this->translatable)) {
                        $column = sprintf('%s->%s', $column, \App::getLocale());
                    }
                    $value = array_shift($parameters);
                    $query->$method($column, $value);
                } else {
                    $connector = $segment;
                }
            }
            return $query;
        }

        return parent::__call($method, $parameters);
    }
}


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			*
40			* @return mixed
41			*/
42			public function getTranslation(string $key, string $locale)
43			{
44			$locale = $this->normalizeLocale($key, $locale);
45
46			$translations = $this->getTranslations($key);
47
48			$translation = $translations[$locale] ?? '';
49
50			if ($this->hasGetMutator($key)) {
			0 ignored issues – show Documentation Bug introduced 2016-05-03 13:39 UTC by Report Bug Copy Issue Report The method `hasGetMutator` does not exist on `object<Spatie\Translatable\HasTranslations>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
51			return $this->mutateAttribute($key, $translation);
			0 ignored issues – show Documentation Bug introduced 2016-05-03 13:39 UTC by Report Bug Copy Issue Report The method `mutateAttribute` does not exist on `object<Spatie\Translatable\HasTranslations>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
52			}
53
54			return $translation;
55			}
56
57			public function getTranslations($key) : array
58			{
59			$this->guardAgainstUntranslatableAttribute($key);
60
61			return json_decode($this->getAttributes()[$key] ?? '' ?: '{}', true);
			0 ignored issues – show Documentation Bug introduced 2016-05-03 13:39 UTC by Report Bug Copy Issue Report The method `getAttributes` does not exist on `object<Spatie\Translatable\HasTranslations>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } 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(string $key, string $locale, $value)
72			{
73			$this->guardAgainstUntranslatableAttribute($key);
74
75			$translations = $this->getTranslations($key);
76
77			$oldValue = $translations[$locale] ?? '';
78
79			if ($this->hasSetMutator($key)) {
			0 ignored issues – show Documentation Bug introduced 2016-05-03 13:39 UTC by Report Bug Copy Issue Report The method `hasSetMutator` does not exist on `object<Spatie\Translatable\HasTranslations>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } 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-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... Documentation Bug introduced 2016-05-03 13:39 UTC by Report Bug Copy Issue Report The method `asJson` does not exist on `object<Spatie\Translatable\HasTranslations>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } 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(string $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(string $key, string $locale)
117			{
118			$translations = $this->getTranslations($key);
119
120			unset($translations[$locale]);
121
122			$this->setAttribute($key, $translations);
			0 ignored issues – show Documentation Bug introduced 2016-05-03 13:39 UTC by Report Bug Copy Issue Report The method `setAttribute` does not exist on `object<Spatie\Translatable\HasTranslations>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
123
124			return $this;
125			}
126
127			public function getTranslatedLocales(string $key) : array
128			{
129			return array_keys($this->getTranslations($key));
130			}
131
132			protected function isTranslatableAttribute(string $key) : bool
133			{
134			return in_array($key, $this->getTranslatableAttributes());
135			}
136
137			protected function guardAgainstUntranslatableAttribute(string $key)
138			{
139			if (!$this->isTranslatableAttribute($key)) {
140			throw AttributeIsNotTranslatable::make($key, $this);
141			}
142			}
143
144			protected function normalizeLocale(string $key, string $locale) : string
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() : array
158			{
159			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...
160			? $this->translatable
161			: [];
162			}
163
164			public function getCasts() : array
165			{
166			return array_merge(
167			parent::getCasts(),
168			array_fill_keys($this->getTranslatableAttributes(), 'array')
169			);
170			}
171
172			/**
173			* Handle dynamic method calls into the model (hook for builder only).
174			*
175			* @param string $method
176			* @param array $parameters
177			* @return mixed
178			*/
179			public function __call($method, $parameters)
180			{
181			if (in_array($method, ['where', 'orWhere'])) {
182			if (in_array($parameters[0], $this->translatable)) {
183			$parameters[0] = sprintf('%s->%s', $parameters[0], config('app.locale'));
184			}
185			} elseif (\Illuminate\Support\Str::startsWith($method, 'where')) {
186			$finder = substr($method, 5);
187			$segments = preg_split('/(And\|Or)(?=[A-Z])/', $finder, -1, PREG_SPLIT_DELIM_CAPTURE);
188
189			$connector = 'And';
190			$query = $this->newQuery();
			0 ignored issues – show Documentation Bug introduced 2016-05-03 13:39 UTC by Report Bug Copy Issue Report The method `newQuery` does not exist on `object<Spatie\Translatable\HasTranslations>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
191			foreach ($segments as $segment) {
192			if ($segment != 'And' && $segment != 'Or') {
193			$method = ($connector == 'And') ? 'where' : 'orWhere';
194			$column = snake_case($segment);
195			if (in_array($column, $this->translatable)) {
196			$column = sprintf('%s->%s', $column, \App::getLocale());
197			}
198			$value = array_shift($parameters);
199			$query->$method($column, $value);
200			} else {
201			$connector = $segment;
202			}
203			}
204			return $query;
205			}
206
207			return parent::__call($method, $parameters);
208			}
209			}
210

spatie / laravel-translatable

Pull Request — master (#5)

HasTranslations A

Complexity

Size/Duplication

Coupling/Cohesion

14 Methods

Duplication Side-by-Side

Filter issues like