dimsav /
laravel-translatable
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Translatable often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Translatable, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 12 | trait Translatable |
||
| 13 | { |
||
| 14 | protected $defaultLocale; |
||
| 15 | |||
| 16 | /** |
||
| 17 | * Alias for getTranslation(). |
||
| 18 | * |
||
| 19 | * @param string|null $locale |
||
| 20 | * @param bool $withFallback |
||
| 21 | * |
||
| 22 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 23 | */ |
||
| 24 | public function translate($locale = null, $withFallback = false) |
||
| 25 | { |
||
| 26 | return $this->getTranslation($locale, $withFallback); |
||
| 27 | } |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Alias for getTranslation(). |
||
| 31 | * |
||
| 32 | * @param string $locale |
||
| 33 | * |
||
| 34 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 35 | */ |
||
| 36 | public function translateOrDefault($locale) |
||
| 40 | |||
| 41 | /** |
||
| 42 | * Alias for getTranslationOrNew(). |
||
| 43 | * |
||
| 44 | * @param string $locale |
||
| 45 | * |
||
| 46 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 47 | */ |
||
| 48 | public function translateOrNew($locale) |
||
| 52 | |||
| 53 | /** |
||
| 54 | * @param string|null $locale |
||
| 55 | * @param bool $withFallback |
||
| 56 | * |
||
| 57 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 58 | */ |
||
| 59 | public function getTranslation($locale = null, $withFallback = null) |
||
| 60 | { |
||
| 61 | $configFallbackLocale = $this->getFallbackLocale(); |
||
| 62 | $locale = $locale ?: $this->locale(); |
||
| 63 | $withFallback = $withFallback === null ? $this->useFallback() : $withFallback; |
||
| 64 | $fallbackLocale = $this->getFallbackLocale($locale); |
||
| 65 | |||
| 66 | if ($translation = $this->getTranslationByLocaleKey($locale)) { |
||
| 67 | return $translation; |
||
| 68 | } |
||
| 69 | if ($withFallback && $fallbackLocale) { |
||
| 70 | if ($translation = $this->getTranslationByLocaleKey($fallbackLocale)) { |
||
| 71 | return $translation; |
||
| 72 | } |
||
| 73 | if ($translation = $this->getTranslationByLocaleKey($configFallbackLocale)) { |
||
| 74 | return $translation; |
||
| 75 | } |
||
| 76 | } |
||
| 77 | |||
| 78 | return null; |
||
| 79 | } |
||
| 80 | |||
| 81 | /** |
||
| 82 | * @param string|null $locale |
||
| 83 | * |
||
| 84 | * @return bool |
||
| 85 | */ |
||
| 86 | public function hasTranslation($locale = null) |
||
| 87 | { |
||
| 88 | $locale = $locale ?: $this->locale(); |
||
| 89 | |||
| 90 | foreach ($this->translations as $translation) { |
||
|
|
|||
| 91 | if ($translation->getAttribute($this->getLocaleKey()) == $locale) { |
||
| 92 | return true; |
||
| 93 | } |
||
| 94 | } |
||
| 95 | |||
| 96 | return false; |
||
| 97 | } |
||
| 98 | |||
| 99 | /** |
||
| 100 | * @return string |
||
| 101 | */ |
||
| 102 | public function getTranslationModelName() |
||
| 106 | |||
| 107 | /** |
||
| 108 | * @return string |
||
| 109 | */ |
||
| 110 | public function getTranslationModelNameDefault() |
||
| 111 | { |
||
| 112 | return get_class($this).config('translatable.translation_suffix', 'Translation'); |
||
| 113 | } |
||
| 114 | |||
| 115 | /** |
||
| 116 | * @return string |
||
| 117 | */ |
||
| 118 | public function getRelationKey() |
||
| 130 | |||
| 131 | /** |
||
| 132 | * @return string |
||
| 133 | */ |
||
| 134 | public function getLocaleKey() |
||
| 135 | { |
||
| 136 | return $this->localeKey ?: config('translatable.locale_key', 'locale'); |
||
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * @return \Illuminate\Database\Eloquent\Relations\HasMany |
||
| 141 | */ |
||
| 142 | public function translations() |
||
| 143 | { |
||
| 144 | return $this->hasMany($this->getTranslationModelName(), $this->getRelationKey()); |
||
| 145 | } |
||
| 146 | |||
| 147 | /** |
||
| 148 | * @return bool |
||
| 149 | */ |
||
| 150 | private function usePropertyFallback() |
||
| 151 | { |
||
| 152 | return config('translatable.use_property_fallback', false); |
||
| 153 | } |
||
| 154 | |||
| 155 | /** |
||
| 156 | * Returns the attribute value from fallback translation if value of attribute |
||
| 157 | * is empty and the property fallback is enabled in the configuration. |
||
| 158 | * in model. |
||
| 159 | * @param $locale |
||
| 160 | * @param $attribute |
||
| 161 | * @return mixed |
||
| 162 | */ |
||
| 163 | private function getAttributeOrFallback($locale, $attribute) |
||
| 164 | { |
||
| 165 | $value = $this->getTranslation($locale)->$attribute; |
||
| 166 | |||
| 167 | $usePropertyFallback = $this->useFallback() && $this->usePropertyFallback(); |
||
| 168 | if ( |
||
| 169 | empty($value) && |
||
| 170 | $usePropertyFallback && |
||
| 171 | ($fallback = $this->getTranslation($this->getFallbackLocale(), true)) |
||
| 172 | ) { |
||
| 173 | return $fallback->$attribute; |
||
| 174 | } |
||
| 175 | |||
| 176 | return $value; |
||
| 177 | } |
||
| 178 | |||
| 179 | /** |
||
| 180 | * @param string $key |
||
| 181 | * |
||
| 182 | * @return mixed |
||
| 183 | */ |
||
| 184 | public function getAttribute($key) |
||
| 207 | |||
| 208 | /** |
||
| 209 | * @param string $key |
||
| 210 | * @param mixed $value |
||
| 211 | * |
||
| 212 | * @return $this |
||
| 213 | */ |
||
| 214 | public function setAttribute($key, $value) |
||
| 226 | |||
| 227 | /** |
||
| 228 | * @param array $options |
||
| 229 | * |
||
| 230 | * @return bool |
||
| 231 | */ |
||
| 232 | public function save(array $options = []) |
||
| 260 | |||
| 261 | /** |
||
| 262 | * @param string $locale |
||
| 263 | * |
||
| 264 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 265 | */ |
||
| 266 | protected function getTranslationOrNew($locale) |
||
| 274 | |||
| 275 | /** |
||
| 276 | * @param array $attributes |
||
| 277 | * |
||
| 278 | * @throws \Illuminate\Database\Eloquent\MassAssignmentException |
||
| 279 | * @return $this |
||
| 280 | */ |
||
| 281 | public function fill(array $attributes) |
||
| 282 | { |
||
| 283 | foreach ($attributes as $key => $values) { |
||
| 284 | if ($this->isKeyALocale($key)) { |
||
| 285 | $this->getTranslationOrNew($key)->fill($values); |
||
| 286 | unset($attributes[$key]); |
||
| 287 | } else { |
||
| 288 | list($attribute, $locale) = $this->getAttributeAndLocale($key); |
||
| 289 | if ($this->isTranslationAttribute($attribute) and $this->isKeyALocale($locale)) { |
||
| 290 | $this->getTranslationOrNew($locale)->fill([$attribute => $values]); |
||
| 291 | unset($attributes[$key]); |
||
| 292 | } |
||
| 293 | } |
||
| 294 | } |
||
| 295 | |||
| 296 | return parent::fill($attributes); |
||
| 297 | } |
||
| 298 | |||
| 299 | /** |
||
| 300 | * @param string $key |
||
| 301 | */ |
||
| 302 | private function getTranslationByLocaleKey($key) |
||
| 312 | |||
| 313 | /** |
||
| 314 | * @param null $locale |
||
| 315 | * |
||
| 316 | * @return string |
||
| 317 | */ |
||
| 318 | private function getFallbackLocale($locale = null) |
||
| 328 | |||
| 329 | /** |
||
| 330 | * @param $locale |
||
| 331 | * |
||
| 332 | * @return bool |
||
| 333 | */ |
||
| 334 | private function isLocaleCountryBased($locale) |
||
| 338 | |||
| 339 | /** |
||
| 340 | * @param $locale |
||
| 341 | * |
||
| 342 | * @return string |
||
| 343 | */ |
||
| 344 | private function getLanguageFromCountryBasedLocale($locale) |
||
| 350 | |||
| 351 | /** |
||
| 352 | * @return bool|null |
||
| 353 | */ |
||
| 354 | private function useFallback() |
||
| 362 | |||
| 363 | /** |
||
| 364 | * @param string $key |
||
| 365 | * |
||
| 366 | * @return bool |
||
| 367 | */ |
||
| 368 | public function isTranslationAttribute($key) |
||
| 372 | |||
| 373 | /** |
||
| 374 | * @param string $key |
||
| 375 | * |
||
| 376 | * @throws \Dimsav\Translatable\Exception\LocalesNotDefinedException |
||
| 377 | * @return bool |
||
| 378 | */ |
||
| 379 | protected function isKeyALocale($key) |
||
| 385 | |||
| 386 | /** |
||
| 387 | * @throws \Dimsav\Translatable\Exception\LocalesNotDefinedException |
||
| 388 | * @return array |
||
| 389 | */ |
||
| 390 | protected function getLocales() |
||
| 413 | |||
| 414 | /** |
||
| 415 | * @return string |
||
| 416 | */ |
||
| 417 | protected function getLocaleSeparator() |
||
| 421 | |||
| 422 | /** |
||
| 423 | * @return bool |
||
| 424 | */ |
||
| 425 | protected function saveTranslations() |
||
| 441 | |||
| 442 | /** |
||
| 443 | * @param array |
||
| 444 | * |
||
| 445 | * @return \Illuminate\Database\Eloquent\Model |
||
| 446 | */ |
||
| 447 | public function replicateWithTranslations(array $except = null) |
||
| 459 | |||
| 460 | /** |
||
| 461 | * @param \Illuminate\Database\Eloquent\Model $translation |
||
| 462 | * |
||
| 463 | * @return bool |
||
| 464 | */ |
||
| 465 | protected function isTranslationDirty(Model $translation) |
||
| 472 | |||
| 473 | /** |
||
| 474 | * @param string $locale |
||
| 475 | * |
||
| 476 | * @return \Illuminate\Database\Eloquent\Model |
||
| 477 | */ |
||
| 478 | public function getNewTranslation($locale) |
||
| 487 | |||
| 488 | /** |
||
| 489 | * @param $key |
||
| 490 | * |
||
| 491 | * @return bool |
||
| 492 | */ |
||
| 493 | public function __isset($key) |
||
| 497 | |||
| 498 | /** |
||
| 499 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 500 | * @param string $locale |
||
| 501 | * |
||
| 502 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 503 | */ |
||
| 504 | View Code Duplication | public function scopeTranslatedIn(Builder $query, $locale = null) |
|
| 512 | |||
| 513 | /** |
||
| 514 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 515 | * @param string $locale |
||
| 516 | * |
||
| 517 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 518 | */ |
||
| 519 | View Code Duplication | public function scopeNotTranslatedIn(Builder $query, $locale = null) |
|
| 527 | |||
| 528 | /** |
||
| 529 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 530 | * |
||
| 531 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 532 | */ |
||
| 533 | public function scopeTranslated(Builder $query) |
||
| 537 | |||
| 538 | /** |
||
| 539 | * Adds scope to get a list of translated attributes, using the current locale. |
||
| 540 | * Example usage: Country::listsTranslations('name')->get()->toArray() |
||
| 541 | * Will return an array with items: |
||
| 542 | * [ |
||
| 543 | * 'id' => '1', // The id of country |
||
| 544 | * 'name' => 'Griechenland' // The translated name |
||
| 545 | * ]. |
||
| 546 | * |
||
| 547 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 548 | * @param string $translationField |
||
| 549 | */ |
||
| 550 | public function scopeListsTranslations(Builder $query, $translationField) |
||
| 574 | |||
| 575 | /** |
||
| 576 | * This scope eager loads the translations for the default and the fallback locale only. |
||
| 577 | * We can use this as a shortcut to improve performance in our application. |
||
| 578 | * |
||
| 579 | * @param Builder $query |
||
| 580 | */ |
||
| 581 | public function scopeWithTranslation(Builder $query) |
||
| 593 | |||
| 594 | /** |
||
| 595 | * This scope filters results by checking the translation fields. |
||
| 596 | * |
||
| 597 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 598 | * @param string $key |
||
| 599 | * @param string $value |
||
| 600 | * @param string $locale |
||
| 601 | * |
||
| 602 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 603 | */ |
||
| 604 | View Code Duplication | public function scopeWhereTranslation(Builder $query, $key, $value, $locale = null) |
|
| 613 | |||
| 614 | /** |
||
| 615 | * This scope filters results by checking the translation fields. |
||
| 616 | * |
||
| 617 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 618 | * @param string $key |
||
| 619 | * @param string $value |
||
| 620 | * @param string $locale |
||
| 621 | * |
||
| 622 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 623 | */ |
||
| 624 | public function scopeOrWhereTranslation(Builder $query, $key, $value, $locale = null) |
||
| 633 | |||
| 634 | /** |
||
| 635 | * This scope filters results by checking the translation fields. |
||
| 636 | * |
||
| 637 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 638 | * @param string $key |
||
| 639 | * @param string $value |
||
| 640 | * @param string $locale |
||
| 641 | * |
||
| 642 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 643 | */ |
||
| 644 | View Code Duplication | public function scopeWhereTranslationLike(Builder $query, $key, $value, $locale = null) |
|
| 653 | |||
| 654 | /** |
||
| 655 | * This scope filters results by checking the translation fields. |
||
| 656 | * |
||
| 657 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 658 | * @param string $key |
||
| 659 | * @param string $value |
||
| 660 | * @param string $locale |
||
| 661 | * |
||
| 662 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 663 | */ |
||
| 664 | public function scopeOrWhereTranslationLike(Builder $query, $key, $value, $locale = null) |
||
| 673 | |||
| 674 | /** |
||
| 675 | * @return array |
||
| 676 | */ |
||
| 677 | public function attributesToArray() |
||
| 699 | |||
| 700 | /** |
||
| 701 | * @return array |
||
| 702 | */ |
||
| 703 | public function getTranslationsArray() |
||
| 715 | |||
| 716 | /** |
||
| 717 | * @return string |
||
| 718 | */ |
||
| 719 | private function getTranslationsTable() |
||
| 723 | |||
| 724 | /** |
||
| 725 | * @return string |
||
| 726 | */ |
||
| 727 | protected function locale() |
||
| 736 | |||
| 737 | /** |
||
| 738 | * Set the default locale on the model. |
||
| 739 | * |
||
| 740 | * @param $locale |
||
| 741 | * |
||
| 742 | * @return $this |
||
| 743 | */ |
||
| 744 | public function setDefaultLocale($locale) |
||
| 750 | |||
| 751 | /** |
||
| 752 | * Get the default locale on the model. |
||
| 753 | * |
||
| 754 | * @return mixed |
||
| 755 | */ |
||
| 756 | public function getDefaultLocale() |
||
| 760 | |||
| 761 | /** |
||
| 762 | * Deletes all translations for this model. |
||
| 763 | * |
||
| 764 | * @param string|array|null $locales The locales to be deleted (array or single string) |
||
| 765 | * (e.g., ["en", "de"] would remove these translations). |
||
| 766 | */ |
||
| 767 | public function deleteTranslations($locales = null) |
||
| 783 | |||
| 784 | /** |
||
| 785 | * @param $key |
||
| 786 | * |
||
| 787 | * @return array |
||
| 788 | */ |
||
| 789 | private function getAttributeAndLocale($key) |
||
| 797 | |||
| 798 | /** |
||
| 799 | * @return bool |
||
| 800 | */ |
||
| 801 | private function toArrayAlwaysLoadsTranslations() |
||
| 805 | } |
||
| 806 |
Loading history...
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: