Test Setup Failed
Pull Request — master (#533)
by Derek
63:34
created

Translatable::scopeWhereTranslationLike()   A

Complexity

Conditions 2
Paths 1

Size

Total Lines 9

Duplication

Lines 9
Ratio 100 %

Importance

Changes 0
Metric Value
dl 9
loc 9
rs 9.9666
c 0
b 0
f 0
cc 2
nc 1
nop 4
1
<?php
2
3
namespace Dimsav\Translatable;
4
5
use Illuminate\Database\Eloquent\Model;
6
use Illuminate\Database\Eloquent\Builder;
7
use Illuminate\Database\Query\JoinClause;
8
use Illuminate\Database\Eloquent\Relations\Relation;
9
use Illuminate\Database\Query\Builder as QueryBuilder;
10
use Dimsav\Translatable\Exception\LocalesNotDefinedException;
11
12
trait Translatable
13
{
14
    protected static $autoloadTranslations = null;
15
16
    protected $defaultLocale;
17
18
    /**
19
     * Alias for getTranslation().
20
     *
21
     * @param string|null $locale
22
     * @param bool        $withFallback
23
     *
24
     * @return \Illuminate\Database\Eloquent\Model|null
25
     */
26
    public function translate($locale = null, $withFallback = false)
27
    {
28
        return $this->getTranslation($locale, $withFallback);
29
    }
30
31
    /**
32
     * Alias for getTranslation().
33
     *
34
     * @param string $locale
35
     *
36
     * @return \Illuminate\Database\Eloquent\Model|null
37
     */
38
    public function translateOrDefault($locale = null)
39
    {
40
        return $this->getTranslation($locale, true);
41
    }
42
43
    /**
44
     * Alias for getTranslationOrNew().
45
     *
46
     * @param string $locale
47
     *
48
     * @return \Illuminate\Database\Eloquent\Model|null
49
     */
50
    public function translateOrNew($locale = null)
51
    {
52
        return $this->getTranslationOrNew($locale);
53
    }
54
55
    /**
56
     * @param string|null $locale
57
     * @param bool        $withFallback
58
     *
59
     * @return \Illuminate\Database\Eloquent\Model|null
60
     */
61
    public function getTranslation($locale = null, $withFallback = null)
62
    {
63
        $configFallbackLocale = $this->getFallbackLocale();
64
        $locale = $locale ?: $this->locale();
65
        $withFallback = $withFallback === null ? $this->useFallback() : $withFallback;
66
        $fallbackLocale = $this->getFallbackLocale($locale);
67
68
        if ($translation = $this->getTranslationByLocaleKey($locale)) {
69
            return $translation;
70
        }
71
        if ($withFallback && $fallbackLocale) {
72
            if ($translation = $this->getTranslationByLocaleKey($fallbackLocale)) {
73
                return $translation;
74
            }
75
            if ($fallbackLocale !== $configFallbackLocale && $translation = $this->getTranslationByLocaleKey($configFallbackLocale)) {
76
                return $translation;
77
            }
78
        }
79
80
        return null;
81
    }
82
83
    /**
84
     * @param string|null $locale
85
     *
86
     * @return bool
87
     */
88
    public function hasTranslation($locale = null)
89
    {
90
        $locale = $locale ?: $this->locale();
91
92
        foreach ($this->translations as $translation) {
0 ignored issues
show
Bug introduced by
The property translations does not seem to exist. Did you mean autoloadTranslations?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
93
            if ($translation->getAttribute($this->getLocaleKey()) == $locale) {
94
                return true;
95
            }
96
        }
97
98
        return false;
99
    }
100
101
    /**
102
     * @return string
103
     */
104
    public function getTranslationModelName()
105
    {
106
        return $this->translationModel ?: $this->getTranslationModelNameDefault();
0 ignored issues
show
Bug introduced by
The property translationModel 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...
107
    }
108
109
    /**
110
     * @return string
111
     */
112
    public function getTranslationModelNameDefault()
113
    {
114
        $modelName = get_class($this);
115
116
        if ($namespace = $this->getTranslationModelNamespace()) {
117
            $modelName = $namespace.'\\'.class_basename(get_class($this));
118
        }
119
120
        return $modelName.config('translatable.translation_suffix', 'Translation');
121
    }
122
123
    /**
124
     * @return string|null
125
     */
126
    public function getTranslationModelNamespace()
127
    {
128
        return config('translatable.translation_model_namespace');
129
    }
130
131
    /**
132
     * @return string
133
     */
134
    public function getRelationKey()
135
    {
136
        if ($this->translationForeignKey) {
137
            $key = $this->translationForeignKey;
0 ignored issues
show
Bug introduced by
The property translationForeignKey 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...
138
        } elseif ($this->primaryKey !== 'id') {
0 ignored issues
show
Bug introduced by
The property primaryKey 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...
139
            $key = $this->primaryKey;
140
        } else {
141
            $key = $this->getForeignKey();
0 ignored issues
show
Bug introduced by
It seems like getForeignKey() 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...
142
        }
143
144
        return $key;
145
    }
146
147
    /**
148
     * @return string
149
     */
150
    public function getLocaleKey()
151
    {
152
        return $this->localeKey ?: config('translatable.locale_key', 'locale');
0 ignored issues
show
Bug introduced by
The property localeKey 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...
153
    }
154
155
    /**
156
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
157
     */
158
    public function translations()
159
    {
160
        return $this->hasMany($this->getTranslationModelName(), $this->getRelationKey());
0 ignored issues
show
Bug introduced by
It seems like hasMany() 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...
161
    }
162
163
    /**
164
     * @return bool
165
     */
166
    private function usePropertyFallback()
167
    {
168
        return $this->useFallback() && config('translatable.use_property_fallback', false);
169
    }
170
171
    /**
172
     * Returns the attribute value from fallback translation if value of attribute
173
     * is empty and the property fallback is enabled in the configuration.
174
     * in model.
175
     * @param $locale
176
     * @param $attribute
177
     * @return mixed
178
     */
179
    private function getAttributeOrFallback($locale, $attribute)
180
    {
181
        $translation = $this->getTranslation($locale);
182
183
        if (
184
            (
185
                ! $translation instanceof Model ||
186
                empty($translation->$attribute)
187
            ) &&
188
            $this->usePropertyFallback()
189
        ) {
190
            $translation = $this->getTranslation($this->getFallbackLocale(), false);
191
        }
192
193
        if ($translation instanceof Model) {
194
            return $translation->$attribute;
195
        }
196
197
        return null;
198
    }
199
200
    /**
201
     * @param string $key
202
     *
203
     * @return mixed
204
     */
205
    public function getAttribute($key)
206
    {
207
        list($attribute, $locale) = $this->getAttributeAndLocale($key);
208
209
        if ($this->isTranslationAttribute($attribute)) {
210
            if ($this->getTranslation($locale) === null) {
211
                return $this->getAttributeValue($attribute);
0 ignored issues
show
Bug introduced by
The method getAttributeValue() does not exist on Dimsav\Translatable\Translatable. Did you maybe mean getAttribute()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
212
            }
213
214
            // If the given $attribute has a mutator, we push it to $attributes and then call getAttributeValue
215
            // on it. This way, we can use Eloquent's checking for Mutation, type casting, and
216
            // Date fields.
217
            if ($this->hasGetMutator($attribute)) {
0 ignored issues
show
Bug introduced by
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...
218
                $this->attributes[$attribute] = $this->getAttributeOrFallback($locale, $attribute);
0 ignored issues
show
Bug introduced by
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...
219
220
                return $this->getAttributeValue($attribute);
0 ignored issues
show
Bug introduced by
The method getAttributeValue() does not exist on Dimsav\Translatable\Translatable. Did you maybe mean getAttribute()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
221
            }
222
223
            return $this->getAttributeOrFallback($locale, $attribute);
224
        }
225
226
        return parent::getAttribute($key);
227
    }
228
229
    /**
230
     * @param string $key
231
     * @param mixed  $value
232
     *
233
     * @return $this
234
     */
235
    public function setAttribute($key, $value)
236
    {
237
        list($attribute, $locale) = $this->getAttributeAndLocale($key);
238
239
        if ($this->isTranslationAttribute($attribute)) {
240
            $this->getTranslationOrNew($locale)->$attribute = $value;
241
        } else {
242
            return parent::setAttribute($key, $value);
243
        }
244
245
        return $this;
246
    }
247
248
    /**
249
     * @param array $options
250
     *
251
     * @return bool
252
     */
253
    public function save(array $options = [])
254
    {
255
        if ($this->exists) {
0 ignored issues
show
Bug introduced by
The property exists 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...
256
            if ($this->isDirty()) {
0 ignored issues
show
Bug introduced by
It seems like isDirty() 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...
257
                // If $this->exists and dirty, parent::save() has to return true. If not,
258
                // an error has occurred. Therefore we shouldn't save the translations.
259
                if (parent::save($options)) {
260
                    return $this->saveTranslations();
261
                }
262
263
                return false;
264
            } else {
265
                // If $this->exists and not dirty, parent::save() skips saving and returns
266
                // false. So we have to save the translations
267
                if ($this->fireModelEvent('saving') === false) {
0 ignored issues
show
Bug introduced by
It seems like fireModelEvent() 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...
268
                    return false;
269
                }
270
271
                if ($saved = $this->saveTranslations()) {
272
                    $this->fireModelEvent('saved', false);
0 ignored issues
show
Bug introduced by
It seems like fireModelEvent() 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...
273
                    $this->fireModelEvent('updated', false);
0 ignored issues
show
Bug introduced by
It seems like fireModelEvent() 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...
274
                }
275
276
                return $saved;
277
            }
278
        } elseif (parent::save($options)) {
279
            // We save the translations only if the instance is saved in the database.
280
            return $this->saveTranslations();
281
        }
282
283
        return false;
284
    }
285
286
    /**
287
     * @param string $locale
288
     *
289
     * @return \Illuminate\Database\Eloquent\Model
290
     */
291
    protected function getTranslationOrNew($locale = null)
292
    {
293
        $locale = $locale ?: $this->locale();
294
295
        if (($translation = $this->getTranslation($locale, false)) === null) {
296
            $translation = $this->getNewTranslation($locale);
297
        }
298
299
        return $translation;
300
    }
301
302
    /**
303
     * @param array $attributes
304
     *
305
     * @throws \Illuminate\Database\Eloquent\MassAssignmentException
306
     * @return $this
307
     */
308
    public function fill(array $attributes)
309
    {
310
        foreach ($attributes as $key => $values) {
311
            if ($this->isKeyALocale($key)) {
312
                $this->getTranslationOrNew($key)->fill($values);
313
                unset($attributes[$key]);
314
            } else {
315
                list($attribute, $locale) = $this->getAttributeAndLocale($key);
316
                if ($this->isTranslationAttribute($attribute) and $this->isKeyALocale($locale)) {
317
                    $this->getTranslationOrNew($locale)->fill([$attribute => $values]);
318
                    unset($attributes[$key]);
319
                }
320
            }
321
        }
322
323
        return parent::fill($attributes);
324
    }
325
326
    /**
327
     * @param string $key
328
     */
329
    private function getTranslationByLocaleKey($key)
330
    {
331
        foreach ($this->translations as $translation) {
0 ignored issues
show
Bug introduced by
The property translations does not seem to exist. Did you mean autoloadTranslations?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
332
            if ($translation->getAttribute($this->getLocaleKey()) == $key) {
333
                return $translation;
334
            }
335
        }
336
337
        return null;
338
    }
339
340
    /**
341
     * @param null $locale
342
     *
343
     * @return string
344
     */
345
    private function getFallbackLocale($locale = null)
346
    {
347
        if ($locale && $this->isLocaleCountryBased($locale)) {
348
            if ($fallback = $this->getLanguageFromCountryBasedLocale($locale)) {
349
                return $fallback;
350
            }
351
        }
352
353
        return config('translatable.fallback_locale');
354
    }
355
356
    /**
357
     * @param $locale
358
     *
359
     * @return bool
360
     */
361
    private function isLocaleCountryBased($locale)
362
    {
363
        return strpos($locale, $this->getLocaleSeparator()) !== false;
364
    }
365
366
    /**
367
     * @param $locale
368
     *
369
     * @return string
370
     */
371
    private function getLanguageFromCountryBasedLocale($locale)
372
    {
373
        $parts = explode($this->getLocaleSeparator(), $locale);
374
375
        return array_get($parts, 0);
376
    }
377
378
    /**
379
     * @return bool|null
380
     */
381
    private function useFallback()
382
    {
383
        if (isset($this->useTranslationFallback) && $this->useTranslationFallback !== null) {
384
            return $this->useTranslationFallback;
0 ignored issues
show
Bug introduced by
The property useTranslationFallback 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...
385
        }
386
387
        return config('translatable.use_fallback');
388
    }
389
390
    /**
391
     * @param string $key
392
     *
393
     * @return bool
394
     */
395
    public function isTranslationAttribute($key)
396
    {
397
        return in_array($key, $this->translatedAttributes);
0 ignored issues
show
Bug introduced by
The property translatedAttributes does not seem to exist. Did you mean attributes?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
398
    }
399
400
    /**
401
     * @param string $key
402
     *
403
     * @throws \Dimsav\Translatable\Exception\LocalesNotDefinedException
404
     * @return bool
405
     */
406
    protected function isKeyALocale($key)
407
    {
408
        $locales = $this->getLocales();
409
410
        return in_array($key, $locales);
411
    }
412
413
    /**
414
     * @throws \Dimsav\Translatable\Exception\LocalesNotDefinedException
415
     * @return array
416
     */
417
    protected function getLocales()
418
    {
419
        $localesConfig = (array) config('translatable.locales');
420
421
        if (empty($localesConfig)) {
422
            throw new LocalesNotDefinedException('Please make sure you have run "php artisan config:publish dimsav/laravel-translatable" '.
423
                ' and that the locales configuration is defined.');
424
        }
425
426
        $locales = [];
427
        foreach ($localesConfig as $key => $locale) {
428
            if (is_array($locale)) {
429
                $locales[] = $key;
430
                foreach ($locale as $countryLocale) {
431
                    $locales[] = $key.$this->getLocaleSeparator().$countryLocale;
432
                }
433
            } else {
434
                $locales[] = $locale;
435
            }
436
        }
437
438
        return $locales;
439
    }
440
441
    /**
442
     * @return string
443
     */
444
    protected function getLocaleSeparator()
445
    {
446
        return config('translatable.locale_separator', '-');
447
    }
448
449
    /**
450
     * @return bool
451
     */
452
    protected function saveTranslations()
453
    {
454
        $saved = true;
455
456
        if (! $this->relationLoaded('translations')) {
0 ignored issues
show
Bug introduced by
It seems like relationLoaded() 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...
457
            return $saved;
458
        }
459
460
        foreach ($this->translations as $translation) {
0 ignored issues
show
Bug introduced by
The property translations does not seem to exist. Did you mean autoloadTranslations?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
461
            if ($saved && $this->isTranslationDirty($translation)) {
462
                if (! empty($connectionName = $this->getConnectionName())) {
0 ignored issues
show
Bug introduced by
It seems like getConnectionName() 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...
463
                    $translation->setConnection($connectionName);
464
                }
465
466
                $translation->setAttribute($this->getRelationKey(), $this->getKey());
0 ignored issues
show
Bug introduced by
It seems like getKey() 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...
467
                $saved = $translation->save();
468
            }
469
        }
470
471
        return $saved;
472
    }
473
474
    /**
475
     * @param array
476
     *
477
     * @return \Illuminate\Database\Eloquent\Model
478
     */
479
    public function replicateWithTranslations(array $except = null)
480
    {
481
        $newInstance = parent::replicate($except);
0 ignored issues
show
Comprehensibility Bug introduced by
It seems like you call parent on a different method (replicate() instead of replicateWithTranslations()). Are you sure this is correct? If so, you might want to change this to $this->replicate().

This check looks for a call to a parent method whose name is different than the method from which it is called.

Consider the following code:

class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

The getFirstName() method in the Son calls the wrong method in the parent class.

Loading history...
482
483
        unset($newInstance->translations);
484
        foreach ($this->translations as $translation) {
0 ignored issues
show
Bug introduced by
The property translations does not seem to exist. Did you mean autoloadTranslations?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
485
            $newTranslation = $translation->replicate();
486
            $newInstance->translations->add($newTranslation);
487
        }
488
489
        return  $newInstance;
490
    }
491
492
    /**
493
     * @param \Illuminate\Database\Eloquent\Model $translation
494
     *
495
     * @return bool
496
     */
497
    protected function isTranslationDirty(Model $translation)
498
    {
499
        $dirtyAttributes = $translation->getDirty();
500
        unset($dirtyAttributes[$this->getLocaleKey()]);
501
502
        return count($dirtyAttributes) > 0;
503
    }
504
505
    /**
506
     * @param string $locale
507
     *
508
     * @return \Illuminate\Database\Eloquent\Model
509
     */
510
    public function getNewTranslation($locale)
511
    {
512
        $modelName = $this->getTranslationModelName();
513
        $translation = new $modelName();
514
        $translation->setAttribute($this->getLocaleKey(), $locale);
515
        $this->translations->add($translation);
0 ignored issues
show
Bug introduced by
The property translations does not seem to exist. Did you mean autoloadTranslations?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
516
517
        return $translation;
518
    }
519
520
    /**
521
     * @param $key
522
     *
523
     * @return bool
524
     */
525
    public function __isset($key)
526
    {
527
        return $this->isTranslationAttribute($key) || parent::__isset($key);
528
    }
529
530
    /**
531
     * @param \Illuminate\Database\Eloquent\Builder $query
532
     * @param string                                $locale
533
     *
534
     * @return \Illuminate\Database\Eloquent\Builder|static
535
     */
536 View Code Duplication
    public function scopeTranslatedIn(Builder $query, $locale = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
537
    {
538
        $locale = $locale ?: $this->locale();
539
540
        return $query->whereHas('translations', function (Builder $q) use ($locale) {
541
            $q->where($this->getLocaleKey(), '=', $locale);
542
        });
543
    }
544
545
    /**
546
     * @param \Illuminate\Database\Eloquent\Builder $query
547
     * @param string                                $locale
548
     *
549
     * @return \Illuminate\Database\Eloquent\Builder|static
550
     */
551 View Code Duplication
    public function scopeNotTranslatedIn(Builder $query, $locale = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
552
    {
553
        $locale = $locale ?: $this->locale();
554
555
        return $query->whereDoesntHave('translations', function (Builder $q) use ($locale) {
556
            $q->where($this->getLocaleKey(), '=', $locale);
557
        });
558
    }
559
560
    /**
561
     * @param \Illuminate\Database\Eloquent\Builder $query
562
     *
563
     * @return \Illuminate\Database\Eloquent\Builder|static
564
     */
565
    public function scopeTranslated(Builder $query)
566
    {
567
        return $query->has('translations');
568
    }
569
570
    /**
571
     * Adds scope to get a list of translated attributes, using the current locale.
572
     * Example usage: Country::listsTranslations('name')->get()->toArray()
573
     * Will return an array with items:
574
     *  [
575
     *      'id' => '1',                // The id of country
576
     *      'name' => 'Griechenland'    // The translated name
577
     *  ].
578
     *
579
     * @param \Illuminate\Database\Eloquent\Builder $query
580
     * @param string                                $translationField
581
     */
582
    public function scopeListsTranslations(Builder $query, $translationField)
583
    {
584
        $withFallback = $this->useFallback();
585
        $translationTable = $this->getTranslationsTable();
586
        $localeKey = $this->getLocaleKey();
587
588
        $query
0 ignored issues
show
Bug introduced by
The method select() does not exist on Illuminate\Database\Eloquent\Builder. Did you maybe mean createSelectWithConstraint()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
589
            ->select($this->getTable().'.'.$this->getKeyName(), $translationTable.'.'.$translationField)
0 ignored issues
show
Bug introduced by
It seems like getTable() 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...
Bug introduced by
It seems like getKeyName() 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...
590
            ->leftJoin($translationTable, $translationTable.'.'.$this->getRelationKey(), '=', $this->getTable().'.'.$this->getKeyName())
0 ignored issues
show
Bug introduced by
It seems like getTable() 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...
Bug introduced by
It seems like getKeyName() 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...
591
            ->where($translationTable.'.'.$localeKey, $this->locale());
592
        if ($withFallback) {
593
            $query->orWhere(function (Builder $q) use ($translationTable, $localeKey) {
594
                $q->where($translationTable.'.'.$localeKey, $this->getFallbackLocale())
595
                  ->whereNotIn($translationTable.'.'.$this->getRelationKey(), function (QueryBuilder $q) use (
596
                      $translationTable,
597
                      $localeKey
598
                  ) {
599
                      $q->select($translationTable.'.'.$this->getRelationKey())
600
                        ->from($translationTable)
601
                        ->where($translationTable.'.'.$localeKey, $this->locale());
602
                  });
603
            });
604
        }
605
    }
606
607
    /**
608
     * This scope eager loads the translations for the default and the fallback locale only.
609
     * We can use this as a shortcut to improve performance in our application.
610
     *
611
     * @param Builder $query
612
     */
613
    public function scopeWithTranslation(Builder $query)
614
    {
615
        $query->with([
616
            'translations' => function (Relation $query) {
617
                if ($this->useFallback()) {
618
                    $locale = $this->locale();
619
                    $countryFallbackLocale = $this->getFallbackLocale($locale); // e.g. de-DE => de
620
                    $locales = array_unique([$locale, $countryFallbackLocale, $this->getFallbackLocale()]);
621
622
                    return $query->whereIn($this->getTranslationsTable().'.'.$this->getLocaleKey(), $locales);
623
                }
624
625
                return $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), $this->locale());
626
            },
627
        ]);
628
    }
629
630
    /**
631
     * This scope filters results by checking the translation fields.
632
     *
633
     * @param \Illuminate\Database\Eloquent\Builder $query
634
     * @param string                                $key
635
     * @param string                                $value
636
     * @param string                                $locale
637
     *
638
     * @return \Illuminate\Database\Eloquent\Builder|static
639
     */
640 View Code Duplication
    public function scopeWhereTranslation(Builder $query, $key, $value, $locale = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
641
    {
642
        return $query->whereHas('translations', function (Builder $query) use ($key, $value, $locale) {
643
            $query->where($this->getTranslationsTable().'.'.$key, $value);
644
            if ($locale) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $locale of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
645
                $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), $locale);
646
            }
647
        });
648
    }
649
650
    /**
651
     * This scope filters results by checking the translation fields.
652
     *
653
     * @param \Illuminate\Database\Eloquent\Builder $query
654
     * @param string                                $key
655
     * @param string                                $value
656
     * @param string                                $locale
657
     *
658
     * @return \Illuminate\Database\Eloquent\Builder|static
659
     */
660 View Code Duplication
    public function scopeOrWhereTranslation(Builder $query, $key, $value, $locale = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
661
    {
662
        return $query->orWhereHas('translations', function (Builder $query) use ($key, $value, $locale) {
663
            $query->where($this->getTranslationsTable().'.'.$key, $value);
664
            if ($locale) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $locale of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
665
                $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), $locale);
666
            }
667
        });
668
    }
669
670
    /**
671
     * This scope filters results by checking the translation fields.
672
     *
673
     * @param \Illuminate\Database\Eloquent\Builder $query
674
     * @param string                                $key
675
     * @param string                                $value
676
     * @param string                                $locale
677
     *
678
     * @return \Illuminate\Database\Eloquent\Builder|static
679
     */
680 View Code Duplication
    public function scopeWhereTranslationLike(Builder $query, $key, $value, $locale = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
681
    {
682
        return $query->whereHas('translations', function (Builder $query) use ($key, $value, $locale) {
683
            $query->where($this->getTranslationsTable().'.'.$key, 'LIKE', $value);
684
            if ($locale) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $locale of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
685
                $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), 'LIKE', $locale);
686
            }
687
        });
688
    }
689
690
    /**
691
     * This scope filters results by checking the translation fields.
692
     *
693
     * @param \Illuminate\Database\Eloquent\Builder $query
694
     * @param string                                $key
695
     * @param string                                $value
696
     * @param string                                $locale
697
     *
698
     * @return \Illuminate\Database\Eloquent\Builder|static
699
     */
700 View Code Duplication
    public function scopeOrWhereTranslationLike(Builder $query, $key, $value, $locale = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
701
    {
702
        return $query->orWhereHas('translations', function (Builder $query) use ($key, $value, $locale) {
703
            $query->where($this->getTranslationsTable().'.'.$key, 'LIKE', $value);
704
            if ($locale) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $locale of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
705
                $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), 'LIKE', $locale);
706
            }
707
        });
708
    }
709
710
    /**
711
     * This scope sorts results by the given translation field.
712
     *
713
     * @param \Illuminate\Database\Eloquent\Builder $query
714
     * @param string                                $key
715
     * @param string                                $sortmethod
716
     *
717
     * @return \Illuminate\Database\Eloquent\Builder|static
718
     */
719
    public function scopeOrderByTranslation(Builder $query, $key, $sortmethod = 'asc')
720
    {
721
        $translationTable = $this->getTranslationsTable();
722
        $localeKey = $this->getLocaleKey();
723
        $table = $this->getTable();
0 ignored issues
show
Bug introduced by
It seems like getTable() 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...
724
        $keyName = $this->getKeyName();
0 ignored issues
show
Bug introduced by
It seems like getKeyName() 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...
725
726
        return $query
727
            ->join($translationTable, function (JoinClause $join) use ($translationTable, $localeKey, $table, $keyName) {
728
                $join
729
                    ->on($translationTable.'.'.$this->getRelationKey(), '=', $table.'.'.$keyName)
730
                    ->where($translationTable.'.'.$localeKey, $this->locale());
731
            })
732
            ->orderBy($translationTable.'.'.$key, $sortmethod)
733
            ->select($table.'.*')
734
            ->with('translations');
735
    }
736
737
    /**
738
     * @return array
739
     */
740
    public function attributesToArray()
741
    {
742
        $attributes = parent::attributesToArray();
743
744
        if (
745
            (! $this->relationLoaded('translations') && ! $this->toArrayAlwaysLoadsTranslations() && is_null(self::$autoloadTranslations))
0 ignored issues
show
Bug introduced by
It seems like relationLoaded() 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...
746
            || self::$autoloadTranslations === false
747
        ) {
748
            return $attributes;
749
        }
750
751
        $hiddenAttributes = $this->getHidden();
0 ignored issues
show
Bug introduced by
It seems like getHidden() 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...
752
753
        foreach ($this->translatedAttributes as $field) {
0 ignored issues
show
Bug introduced by
The property translatedAttributes does not seem to exist. Did you mean attributes?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
754
            if (in_array($field, $hiddenAttributes)) {
755
                continue;
756
            }
757
758
            $attributes[$field] = $this->getAttributeOrFallback(null, $field);
759
        }
760
761
        return $attributes;
762
    }
763
764
    /**
765
     * @return array
766
     */
767
    public function getTranslationsArray()
768
    {
769
        $translations = [];
770
771
        foreach ($this->translations as $translation) {
0 ignored issues
show
Bug introduced by
The property translations does not seem to exist. Did you mean autoloadTranslations?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
772
            foreach ($this->translatedAttributes as $attr) {
0 ignored issues
show
Bug introduced by
The property translatedAttributes does not seem to exist. Did you mean attributes?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
773
                $translations[$translation->{$this->getLocaleKey()}][$attr] = $translation->{$attr};
774
            }
775
        }
776
777
        return $translations;
778
    }
779
780
    /**
781
     * @return string
782
     */
783
    private function getTranslationsTable()
784
    {
785
        return app()->make($this->getTranslationModelName())->getTable();
786
    }
787
788
    /**
789
     * @return string
790
     */
791
    protected function locale()
792
    {
793
        if ($this->defaultLocale) {
794
            return $this->defaultLocale;
795
        }
796
797
        return config('translatable.locale')
798
            ?: app()->make('translator')->getLocale();
799
    }
800
801
    /**
802
     * Set the default locale on the model.
803
     *
804
     * @param $locale
805
     *
806
     * @return $this
807
     */
808
    public function setDefaultLocale($locale)
809
    {
810
        $this->defaultLocale = $locale;
811
812
        return $this;
813
    }
814
815
    /**
816
     * Get the default locale on the model.
817
     *
818
     * @return mixed
819
     */
820
    public function getDefaultLocale()
821
    {
822
        return $this->defaultLocale;
823
    }
824
825
    /**
826
     * Deletes all translations for this model.
827
     *
828
     * @param string|array|null $locales The locales to be deleted (array or single string)
829
     *                                   (e.g., ["en", "de"] would remove these translations).
830
     */
831
    public function deleteTranslations($locales = null)
832
    {
833
        if ($locales === null) {
834
            $translations = $this->translations()->get();
835
        } else {
836
            $locales = (array) $locales;
837
            $translations = $this->translations()->whereIn($this->getLocaleKey(), $locales)->get();
838
        }
839
        foreach ($translations as $translation) {
840
            $translation->delete();
841
        }
842
843
        // we need to manually "reload" the collection built from the relationship
844
        // otherwise $this->translations()->get() would NOT be the same as $this->translations
845
        $this->load('translations');
0 ignored issues
show
Bug introduced by
It seems like load() 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...
846
    }
847
848
    /**
849
     * @param $key
850
     *
851
     * @return array
852
     */
853
    private function getAttributeAndLocale($key)
854
    {
855
        if (str_contains($key, ':')) {
856
            return explode(':', $key);
857
        }
858
859
        return [$key, $this->locale()];
860
    }
861
862
    /**
863
     * @return bool
864
     */
865
    private function toArrayAlwaysLoadsTranslations()
866
    {
867
        return config('translatable.to_array_always_loads_translations', true);
868
    }
869
870
    public static function enableAutoloadTranslations()
871
    {
872
        self::$autoloadTranslations = true;
873
    }
874
875
    public static function defaultAutoloadTranslations()
876
    {
877
        self::$autoloadTranslations = null;
878
    }
879
880
    public static function disableAutoloadTranslations()
881
    {
882
        self::$autoloadTranslations = false;
883
    }
884
}
885