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 |
||
| 11 | trait Translatable |
||
| 12 | { |
||
| 13 | protected $defaultLocale; |
||
| 14 | |||
| 15 | /** |
||
| 16 | * Alias for getTranslation(). |
||
| 17 | * |
||
| 18 | * @param string|null $locale |
||
| 19 | * @param bool $withFallback |
||
| 20 | * |
||
| 21 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 22 | */ |
||
| 23 | public function translate($locale = null, $withFallback = false) |
||
| 24 | { |
||
| 25 | return $this->getTranslation($locale, $withFallback); |
||
| 26 | } |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Alias for getTranslation(). |
||
| 30 | * |
||
| 31 | * @param string $locale |
||
| 32 | * |
||
| 33 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 34 | */ |
||
| 35 | public function translateOrDefault($locale) |
||
| 36 | { |
||
| 37 | return $this->getTranslation($locale, true); |
||
| 38 | } |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Alias for getTranslationOrNew(). |
||
| 42 | * |
||
| 43 | * @param string $locale |
||
| 44 | * |
||
| 45 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 46 | */ |
||
| 47 | public function translateOrNew($locale) |
||
| 48 | { |
||
| 49 | return $this->getTranslationOrNew($locale); |
||
| 50 | } |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @param string|null $locale |
||
| 54 | * @param bool $withFallback |
||
| 55 | * |
||
| 56 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 57 | */ |
||
| 58 | public function getTranslation($locale = null, $withFallback = null) |
||
| 59 | { |
||
| 60 | $configFallbackLocale = $this->getFallbackLocale(); |
||
| 61 | $locale = $locale ?: $this->locale(); |
||
| 62 | $withFallback = $withFallback === null ? $this->useFallback() : $withFallback; |
||
| 63 | $fallbackLocale = $this->getFallbackLocale($locale); |
||
| 64 | |||
| 65 | if ($translation = $this->getTranslationByLocaleKey($locale)) { |
||
| 66 | return $translation; |
||
| 67 | } |
||
| 68 | if ($withFallback && $fallbackLocale) { |
||
| 69 | if ($translation = $this->getTranslationByLocaleKey($fallbackLocale)) { |
||
| 70 | return $translation; |
||
| 71 | } |
||
| 72 | if ($translation = $this->getTranslationByLocaleKey($configFallbackLocale)) { |
||
| 73 | return $translation; |
||
| 74 | } |
||
| 75 | } |
||
| 76 | |||
| 77 | return null; |
||
| 78 | } |
||
| 79 | |||
| 80 | /** |
||
| 81 | * @param string|null $locale |
||
| 82 | * |
||
| 83 | * @return bool |
||
| 84 | */ |
||
| 85 | public function hasTranslation($locale = null) |
||
| 86 | { |
||
| 87 | $locale = $locale ?: $this->locale(); |
||
| 88 | |||
| 89 | foreach ($this->translations as $translation) { |
||
|
|
|||
| 90 | if ($translation->getAttribute($this->getLocaleKey()) == $locale) { |
||
| 91 | return true; |
||
| 92 | } |
||
| 93 | } |
||
| 94 | |||
| 95 | return false; |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * @return string |
||
| 100 | */ |
||
| 101 | public function getTranslationModelName() |
||
| 102 | { |
||
| 103 | return $this->translationModel ?: $this->getTranslationModelNameDefault(); |
||
| 104 | } |
||
| 105 | |||
| 106 | /** |
||
| 107 | * @return string |
||
| 108 | */ |
||
| 109 | public function getTranslationModelNameDefault() |
||
| 110 | { |
||
| 111 | return get_class($this).config('translatable.translation_suffix', 'Translation'); |
||
| 112 | } |
||
| 113 | |||
| 114 | /** |
||
| 115 | * @return string |
||
| 116 | */ |
||
| 117 | public function getRelationKey() |
||
| 118 | { |
||
| 119 | if ($this->translationForeignKey) { |
||
| 120 | $key = $this->translationForeignKey; |
||
| 121 | } elseif ($this->primaryKey !== 'id') { |
||
| 122 | $key = $this->primaryKey; |
||
| 123 | } else { |
||
| 124 | $key = $this->getForeignKey(); |
||
| 125 | } |
||
| 126 | |||
| 127 | return $key; |
||
| 128 | } |
||
| 129 | |||
| 130 | /** |
||
| 131 | * @return string |
||
| 132 | */ |
||
| 133 | public function getLocaleKey() |
||
| 134 | { |
||
| 135 | return $this->localeKey ?: config('translatable.locale_key', 'locale'); |
||
| 136 | } |
||
| 137 | |||
| 138 | /** |
||
| 139 | * @return \Illuminate\Database\Eloquent\Relations\HasMany |
||
| 140 | */ |
||
| 141 | public function translations() |
||
| 142 | { |
||
| 143 | return $this->hasMany($this->getTranslationModelName(), $this->getRelationKey()); |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * @return bool |
||
| 148 | */ |
||
| 149 | private function usePropertyFallback() |
||
| 150 | { |
||
| 151 | return $this->useFallback() && config('translatable.use_property_fallback', false); |
||
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Returns the attribute value from fallback translation if value of attribute |
||
| 156 | * is empty and the property fallback is enabled in the configuration. |
||
| 157 | * in model. |
||
| 158 | * @param $locale |
||
| 159 | * @param $attribute |
||
| 160 | * @return mixed |
||
| 161 | */ |
||
| 162 | private function getAttributeOrFallback($locale, $attribute) |
||
| 163 | { |
||
| 164 | $value = $this->getTranslation($locale)->$attribute; |
||
| 165 | |||
| 166 | if ( |
||
| 167 | empty($value) && |
||
| 168 | $this->usePropertyFallback() && |
||
| 169 | ($fallback = $this->getTranslation($this->getFallbackLocale(), true)) |
||
| 170 | ) { |
||
| 171 | return $fallback->$attribute; |
||
| 172 | } |
||
| 173 | |||
| 174 | return $value; |
||
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * @param string $key |
||
| 179 | * |
||
| 180 | * @return mixed |
||
| 181 | */ |
||
| 182 | public function getAttribute($key) |
||
| 183 | { |
||
| 184 | list($attribute, $locale) = $this->getAttributeAndLocale($key); |
||
| 185 | |||
| 186 | if ($this->isTranslationAttribute($attribute)) { |
||
| 187 | if ($this->getTranslation($locale) === null) { |
||
| 188 | return $this->getAttributeValue($attribute); |
||
| 189 | } |
||
| 190 | |||
| 191 | // If the given $attribute has a mutator, we push it to $attributes and then call getAttributeValue |
||
| 192 | // on it. This way, we can use Eloquent's checking for Mutation, type casting, and |
||
| 193 | // Date fields. |
||
| 194 | if ($this->hasGetMutator($attribute)) { |
||
| 195 | $this->attributes[$attribute] = $this->getAttributeOrFallback($locale, $attribute); |
||
| 196 | |||
| 197 | return $this->getAttributeValue($attribute); |
||
| 198 | } |
||
| 199 | |||
| 200 | return $this->getAttributeOrFallback($locale, $attribute); |
||
| 201 | } |
||
| 202 | |||
| 203 | return parent::getAttribute($key); |
||
| 204 | } |
||
| 205 | |||
| 206 | /** |
||
| 207 | * @param string $key |
||
| 208 | * @param mixed $value |
||
| 209 | * |
||
| 210 | * @return $this |
||
| 211 | */ |
||
| 212 | public function setAttribute($key, $value) |
||
| 213 | { |
||
| 214 | list($attribute, $locale) = $this->getAttributeAndLocale($key); |
||
| 215 | |||
| 216 | if ($this->isTranslationAttribute($attribute)) { |
||
| 217 | $this->getTranslationOrNew($locale)->$attribute = $value; |
||
| 218 | } else { |
||
| 219 | return parent::setAttribute($key, $value); |
||
| 220 | } |
||
| 221 | |||
| 222 | return $this; |
||
| 223 | } |
||
| 224 | |||
| 225 | /** |
||
| 226 | * @param array $options |
||
| 227 | * |
||
| 228 | * @return bool |
||
| 229 | */ |
||
| 230 | public function save(array $options = []) |
||
| 231 | { |
||
| 232 | if ($this->exists) { |
||
| 233 | if ($this->isDirty()) { |
||
| 234 | // If $this->exists and dirty, parent::save() has to return true. If not, |
||
| 235 | // an error has occurred. Therefore we shouldn't save the translations. |
||
| 236 | if (parent::save($options)) { |
||
| 237 | return $this->saveTranslations(); |
||
| 238 | } |
||
| 239 | |||
| 240 | return false; |
||
| 241 | } else { |
||
| 242 | // If $this->exists and not dirty, parent::save() skips saving and returns |
||
| 243 | // false. So we have to save the translations |
||
| 244 | if ($saved = $this->saveTranslations()) { |
||
| 245 | $this->fireModelEvent('saved', false); |
||
| 246 | $this->fireModelEvent('updated', false); |
||
| 247 | } |
||
| 248 | |||
| 249 | return $saved; |
||
| 250 | } |
||
| 251 | } elseif (parent::save($options)) { |
||
| 252 | // We save the translations only if the instance is saved in the database. |
||
| 253 | return $this->saveTranslations(); |
||
| 254 | } |
||
| 255 | |||
| 256 | return false; |
||
| 257 | } |
||
| 258 | |||
| 259 | /** |
||
| 260 | * @param string $locale |
||
| 261 | * |
||
| 262 | * @return \Illuminate\Database\Eloquent\Model|null |
||
| 263 | */ |
||
| 264 | protected function getTranslationOrNew($locale) |
||
| 265 | { |
||
| 266 | if (($translation = $this->getTranslation($locale, false)) === null) { |
||
| 267 | $translation = $this->getNewTranslation($locale); |
||
| 268 | } |
||
| 269 | |||
| 270 | return $translation; |
||
| 271 | } |
||
| 272 | |||
| 273 | /** |
||
| 274 | * @param array $attributes |
||
| 275 | * |
||
| 276 | * @throws \Illuminate\Database\Eloquent\MassAssignmentException |
||
| 277 | * @return $this |
||
| 278 | */ |
||
| 279 | public function fill(array $attributes) |
||
| 280 | { |
||
| 281 | foreach ($attributes as $key => $values) { |
||
| 282 | if ($this->isKeyALocale($key)) { |
||
| 283 | $this->getTranslationOrNew($key)->fill($values); |
||
| 284 | unset($attributes[$key]); |
||
| 285 | } else { |
||
| 286 | list($attribute, $locale) = $this->getAttributeAndLocale($key); |
||
| 287 | if ($this->isTranslationAttribute($attribute) and $this->isKeyALocale($locale)) { |
||
| 288 | $this->getTranslationOrNew($locale)->fill([$attribute => $values]); |
||
| 289 | unset($attributes[$key]); |
||
| 290 | } |
||
| 291 | } |
||
| 292 | } |
||
| 293 | |||
| 294 | return parent::fill($attributes); |
||
| 295 | } |
||
| 296 | |||
| 297 | /** |
||
| 298 | * @param string $key |
||
| 299 | */ |
||
| 300 | private function getTranslationByLocaleKey($key) |
||
| 301 | { |
||
| 302 | foreach ($this->translations as $translation) { |
||
| 303 | if ($translation->getAttribute($this->getLocaleKey()) == $key) { |
||
| 304 | return $translation; |
||
| 305 | } |
||
| 306 | } |
||
| 307 | |||
| 308 | return null; |
||
| 309 | } |
||
| 310 | |||
| 311 | /** |
||
| 312 | * @param null $locale |
||
| 313 | * |
||
| 314 | * @return string |
||
| 315 | */ |
||
| 316 | private function getFallbackLocale($locale = null) |
||
| 317 | { |
||
| 318 | if ($locale && $this->isLocaleCountryBased($locale)) { |
||
| 319 | if ($fallback = $this->getLanguageFromCountryBasedLocale($locale)) { |
||
| 320 | return $fallback; |
||
| 321 | } |
||
| 322 | } |
||
| 323 | |||
| 324 | return config('translatable.fallback_locale'); |
||
| 325 | } |
||
| 326 | |||
| 327 | /** |
||
| 328 | * @param $locale |
||
| 329 | * |
||
| 330 | * @return bool |
||
| 331 | */ |
||
| 332 | private function isLocaleCountryBased($locale) |
||
| 333 | { |
||
| 334 | return strpos($locale, $this->getLocaleSeparator()) !== false; |
||
| 335 | } |
||
| 336 | |||
| 337 | /** |
||
| 338 | * @param $locale |
||
| 339 | * |
||
| 340 | * @return string |
||
| 341 | */ |
||
| 342 | private function getLanguageFromCountryBasedLocale($locale) |
||
| 343 | { |
||
| 344 | $parts = explode($this->getLocaleSeparator(), $locale); |
||
| 345 | |||
| 346 | return array_get($parts, 0); |
||
| 347 | } |
||
| 348 | |||
| 349 | /** |
||
| 350 | * @return bool|null |
||
| 351 | */ |
||
| 352 | private function useFallback() |
||
| 353 | { |
||
| 354 | if (isset($this->useTranslationFallback) && $this->useTranslationFallback !== null) { |
||
| 355 | return $this->useTranslationFallback; |
||
| 356 | } |
||
| 357 | |||
| 358 | return config('translatable.use_fallback'); |
||
| 359 | } |
||
| 360 | |||
| 361 | /** |
||
| 362 | * @param string $key |
||
| 363 | * |
||
| 364 | * @return bool |
||
| 365 | */ |
||
| 366 | public function isTranslationAttribute($key) |
||
| 367 | { |
||
| 368 | return in_array($key, $this->translatedAttributes); |
||
| 369 | } |
||
| 370 | |||
| 371 | /** |
||
| 372 | * @param string $key |
||
| 373 | * |
||
| 374 | * @throws \Dimsav\Translatable\Exception\LocalesNotDefinedException |
||
| 375 | * @return bool |
||
| 376 | */ |
||
| 377 | protected function isKeyALocale($key) |
||
| 378 | { |
||
| 379 | $locales = $this->getLocales(); |
||
| 380 | |||
| 381 | return in_array($key, $locales); |
||
| 382 | } |
||
| 383 | |||
| 384 | /** |
||
| 385 | * @throws \Dimsav\Translatable\Exception\LocalesNotDefinedException |
||
| 386 | * @return array |
||
| 387 | */ |
||
| 388 | protected function getLocales() |
||
| 389 | { |
||
| 390 | $localesConfig = (array) config('translatable.locales'); |
||
| 391 | |||
| 392 | if (empty($localesConfig)) { |
||
| 393 | throw new LocalesNotDefinedException('Please make sure you have run "php artisan config:publish dimsav/laravel-translatable" '. |
||
| 394 | ' and that the locales configuration is defined.'); |
||
| 395 | } |
||
| 396 | |||
| 397 | $locales = []; |
||
| 398 | foreach ($localesConfig as $key => $locale) { |
||
| 399 | if (is_array($locale)) { |
||
| 400 | $locales[] = $key; |
||
| 401 | foreach ($locale as $countryLocale) { |
||
| 402 | $locales[] = $key.$this->getLocaleSeparator().$countryLocale; |
||
| 403 | } |
||
| 404 | } else { |
||
| 405 | $locales[] = $locale; |
||
| 406 | } |
||
| 407 | } |
||
| 408 | |||
| 409 | return $locales; |
||
| 410 | } |
||
| 411 | |||
| 412 | /** |
||
| 413 | * @return string |
||
| 414 | */ |
||
| 415 | protected function getLocaleSeparator() |
||
| 416 | { |
||
| 417 | return config('translatable.locale_separator', '-'); |
||
| 418 | } |
||
| 419 | |||
| 420 | /** |
||
| 421 | * @return bool |
||
| 422 | */ |
||
| 423 | protected function saveTranslations() |
||
| 424 | { |
||
| 425 | $saved = true; |
||
| 426 | foreach ($this->translations as $translation) { |
||
| 427 | if ($saved && $this->isTranslationDirty($translation)) { |
||
| 428 | if (! empty($connectionName = $this->getConnectionName())) { |
||
| 429 | $translation->setConnection($connectionName); |
||
| 430 | } |
||
| 431 | |||
| 432 | $translation->setAttribute($this->getRelationKey(), $this->getKey()); |
||
| 433 | $saved = $translation->save(); |
||
| 434 | } |
||
| 435 | } |
||
| 436 | |||
| 437 | return $saved; |
||
| 438 | } |
||
| 439 | |||
| 440 | /** |
||
| 441 | * @param array |
||
| 442 | * |
||
| 443 | * @return \Illuminate\Database\Eloquent\Model |
||
| 444 | */ |
||
| 445 | public function replicateWithTranslations(array $except = null) |
||
| 446 | { |
||
| 447 | $newInstance = parent::replicate($except); |
||
| 448 | |||
| 449 | unset($newInstance->translations); |
||
| 450 | foreach ($this->translations as $translation) { |
||
| 451 | $newTranslation = $translation->replicate(); |
||
| 452 | $newInstance->translations->add($newTranslation); |
||
| 453 | } |
||
| 454 | |||
| 455 | return $newInstance; |
||
| 456 | } |
||
| 457 | |||
| 458 | /** |
||
| 459 | * @param \Illuminate\Database\Eloquent\Model $translation |
||
| 460 | * |
||
| 461 | * @return bool |
||
| 462 | */ |
||
| 463 | protected function isTranslationDirty(Model $translation) |
||
| 464 | { |
||
| 465 | $dirtyAttributes = $translation->getDirty(); |
||
| 466 | unset($dirtyAttributes[$this->getLocaleKey()]); |
||
| 467 | |||
| 468 | return count($dirtyAttributes) > 0; |
||
| 469 | } |
||
| 470 | |||
| 471 | /** |
||
| 472 | * @param string $locale |
||
| 473 | * |
||
| 474 | * @return \Illuminate\Database\Eloquent\Model |
||
| 475 | */ |
||
| 476 | public function getNewTranslation($locale) |
||
| 477 | { |
||
| 478 | $modelName = $this->getTranslationModelName(); |
||
| 479 | $translation = new $modelName(); |
||
| 480 | $translation->setAttribute($this->getLocaleKey(), $locale); |
||
| 481 | $this->translations->add($translation); |
||
| 482 | |||
| 483 | return $translation; |
||
| 484 | } |
||
| 485 | |||
| 486 | /** |
||
| 487 | * @param $key |
||
| 488 | * |
||
| 489 | * @return bool |
||
| 490 | */ |
||
| 491 | public function __isset($key) |
||
| 492 | { |
||
| 493 | return $this->isTranslationAttribute($key) || parent::__isset($key); |
||
| 494 | } |
||
| 495 | |||
| 496 | /** |
||
| 497 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 498 | * @param string $locale |
||
| 499 | * |
||
| 500 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 501 | */ |
||
| 502 | View Code Duplication | public function scopeTranslatedIn(Builder $query, $locale = null) |
|
| 503 | { |
||
| 504 | $locale = $locale ?: $this->locale(); |
||
| 505 | |||
| 506 | return $query->whereHas('translations', function (Builder $q) use ($locale) { |
||
| 507 | $q->where($this->getLocaleKey(), '=', $locale); |
||
| 508 | }); |
||
| 509 | } |
||
| 510 | |||
| 511 | /** |
||
| 512 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 513 | * @param string $locale |
||
| 514 | * |
||
| 515 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 516 | */ |
||
| 517 | View Code Duplication | public function scopeNotTranslatedIn(Builder $query, $locale = null) |
|
| 518 | { |
||
| 519 | $locale = $locale ?: $this->locale(); |
||
| 520 | |||
| 521 | return $query->whereDoesntHave('translations', function (Builder $q) use ($locale) { |
||
| 522 | $q->where($this->getLocaleKey(), '=', $locale); |
||
| 523 | }); |
||
| 524 | } |
||
| 525 | |||
| 526 | /** |
||
| 527 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 528 | * |
||
| 529 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 530 | */ |
||
| 531 | public function scopeTranslated(Builder $query) |
||
| 532 | { |
||
| 533 | return $query->has('translations'); |
||
| 534 | } |
||
| 535 | |||
| 536 | /** |
||
| 537 | * Adds scope to get a list of translated attributes, using the current locale. |
||
| 538 | * Example usage: Country::listsTranslations('name')->get()->toArray() |
||
| 539 | * Will return an array with items: |
||
| 540 | * [ |
||
| 541 | * 'id' => '1', // The id of country |
||
| 542 | * 'name' => 'Griechenland' // The translated name |
||
| 543 | * ]. |
||
| 544 | * |
||
| 545 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 546 | * @param string $translationField |
||
| 547 | */ |
||
| 548 | public function scopeListsTranslations(Builder $query, $translationField) |
||
| 549 | { |
||
| 550 | $withFallback = $this->useFallback(); |
||
| 551 | $translationTable = $this->getTranslationsTable(); |
||
| 552 | $localeKey = $this->getLocaleKey(); |
||
| 553 | |||
| 554 | $query |
||
| 555 | ->select($this->getTable().'.'.$this->getKeyName(), $translationTable.'.'.$translationField) |
||
| 556 | ->leftJoin($translationTable, $translationTable.'.'.$this->getRelationKey(), '=', $this->getTable().'.'.$this->getKeyName()) |
||
| 557 | ->where($translationTable.'.'.$localeKey, $this->locale()); |
||
| 558 | if ($withFallback) { |
||
| 559 | $query->orWhere(function (Builder $q) use ($translationTable, $localeKey) { |
||
| 560 | $q->where($translationTable.'.'.$localeKey, $this->getFallbackLocale()) |
||
| 561 | ->whereNotIn($translationTable.'.'.$this->getRelationKey(), function (QueryBuilder $q) use ( |
||
| 562 | $translationTable, |
||
| 563 | $localeKey |
||
| 564 | ) { |
||
| 565 | $q->select($translationTable.'.'.$this->getRelationKey()) |
||
| 566 | ->from($translationTable) |
||
| 567 | ->where($translationTable.'.'.$localeKey, $this->locale()); |
||
| 568 | }); |
||
| 569 | }); |
||
| 570 | } |
||
| 571 | } |
||
| 572 | |||
| 573 | /** |
||
| 574 | * This scope eager loads the translations for the default and the fallback locale only. |
||
| 575 | * We can use this as a shortcut to improve performance in our application. |
||
| 576 | * |
||
| 577 | * @param Builder $query |
||
| 578 | */ |
||
| 579 | public function scopeWithTranslation(Builder $query) |
||
| 580 | { |
||
| 581 | $query->with([ |
||
| 582 | 'translations' => function (Relation $query) { |
||
| 583 | if ($this->useFallback()) { |
||
| 584 | $locale = $this->locale(); |
||
| 585 | $countryFallbackLocale = $this->getFallbackLocale($locale); // e.g. de-DE => de |
||
| 586 | $locales = array_unique([$locale, $countryFallbackLocale, $this->getFallbackLocale()]); |
||
| 587 | |||
| 588 | return $query->whereIn($this->getTranslationsTable().'.'.$this->getLocaleKey(), $locales); |
||
| 589 | } |
||
| 590 | |||
| 591 | return $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), $this->locale()); |
||
| 592 | }, |
||
| 593 | ]); |
||
| 594 | } |
||
| 595 | |||
| 596 | /** |
||
| 597 | * This scope filters results by checking the translation fields. |
||
| 598 | * |
||
| 599 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 600 | * @param string $key |
||
| 601 | * @param string $value |
||
| 602 | * @param string $locale |
||
| 603 | * |
||
| 604 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 605 | */ |
||
| 606 | View Code Duplication | public function scopeWhereTranslation(Builder $query, $key, $value, $locale = null) |
|
| 607 | { |
||
| 608 | return $query->whereHas('translations', function (Builder $query) use ($key, $value, $locale) { |
||
| 609 | $query->where($this->getTranslationsTable().'.'.$key, $value); |
||
| 610 | if ($locale) { |
||
| 611 | $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), $locale); |
||
| 612 | } |
||
| 613 | }); |
||
| 614 | } |
||
| 615 | |||
| 616 | /** |
||
| 617 | * This scope filters results by checking the translation fields. |
||
| 618 | * |
||
| 619 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 620 | * @param string $key |
||
| 621 | * @param string $value |
||
| 622 | * @param string $locale |
||
| 623 | * |
||
| 624 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 625 | */ |
||
| 626 | View Code Duplication | public function scopeOrWhereTranslation(Builder $query, $key, $value, $locale = null) |
|
| 627 | { |
||
| 628 | return $query->orWhereHas('translations', function (Builder $query) use ($key, $value, $locale) { |
||
| 629 | $query->where($this->getTranslationsTable().'.'.$key, $value); |
||
| 630 | if ($locale) { |
||
| 631 | $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), $locale); |
||
| 632 | } |
||
| 633 | }); |
||
| 634 | } |
||
| 635 | |||
| 636 | /** |
||
| 637 | * This scope filters results by checking the translation fields. |
||
| 638 | * |
||
| 639 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 640 | * @param string $key |
||
| 641 | * @param string $value |
||
| 642 | * @param string $locale |
||
| 643 | * |
||
| 644 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 645 | */ |
||
| 646 | View Code Duplication | public function scopeWhereTranslationLike(Builder $query, $key, $value, $locale = null) |
|
| 647 | { |
||
| 648 | return $query->whereHas('translations', function (Builder $query) use ($key, $value, $locale) { |
||
| 649 | $query->where($this->getTranslationsTable().'.'.$key, 'LIKE', $value); |
||
| 650 | if ($locale) { |
||
| 651 | $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), 'LIKE', $locale); |
||
| 652 | } |
||
| 653 | }); |
||
| 654 | } |
||
| 655 | |||
| 656 | /** |
||
| 657 | * This scope filters results by checking the translation fields. |
||
| 658 | * |
||
| 659 | * @param \Illuminate\Database\Eloquent\Builder $query |
||
| 660 | * @param string $key |
||
| 661 | * @param string $value |
||
| 662 | * @param string $locale |
||
| 663 | * |
||
| 664 | * @return \Illuminate\Database\Eloquent\Builder|static |
||
| 665 | */ |
||
| 666 | View Code Duplication | public function scopeOrWhereTranslationLike(Builder $query, $key, $value, $locale = null) |
|
| 667 | { |
||
| 668 | return $query->orWhereHas('translations', function (Builder $query) use ($key, $value, $locale) { |
||
| 669 | $query->where($this->getTranslationsTable().'.'.$key, 'LIKE', $value); |
||
| 670 | if ($locale) { |
||
| 671 | $query->where($this->getTranslationsTable().'.'.$this->getLocaleKey(), 'LIKE', $locale); |
||
| 672 | } |
||
| 673 | }); |
||
| 674 | } |
||
| 675 | |||
| 676 | /** |
||
| 677 | * @return array |
||
| 678 | */ |
||
| 679 | public function attributesToArray() |
||
| 680 | { |
||
| 681 | $attributes = parent::attributesToArray(); |
||
| 682 | |||
| 683 | if (! $this->relationLoaded('translations') && ! $this->toArrayAlwaysLoadsTranslations()) { |
||
| 684 | return $attributes; |
||
| 685 | } |
||
| 686 | |||
| 687 | $hiddenAttributes = $this->getHidden(); |
||
| 688 | |||
| 689 | foreach ($this->translatedAttributes as $field) { |
||
| 690 | if (in_array($field, $hiddenAttributes)) { |
||
| 691 | continue; |
||
| 692 | } |
||
| 693 | |||
| 694 | if ($translations = $this->getTranslation()) { |
||
| 695 | $attributes[$field] = $translations->$field; |
||
| 696 | } |
||
| 697 | } |
||
| 698 | |||
| 699 | return $attributes; |
||
| 700 | } |
||
| 701 | |||
| 702 | /** |
||
| 703 | * @return array |
||
| 704 | */ |
||
| 705 | public function getTranslationsArray() |
||
| 717 | |||
| 718 | /** |
||
| 719 | * @return string |
||
| 720 | */ |
||
| 721 | private function getTranslationsTable() |
||
| 725 | |||
| 726 | /** |
||
| 727 | * @return string |
||
| 728 | */ |
||
| 729 | protected function locale() |
||
| 738 | |||
| 739 | /** |
||
| 740 | * Set the default locale on the model. |
||
| 741 | * |
||
| 742 | * @param $locale |
||
| 743 | * |
||
| 744 | * @return $this |
||
| 745 | */ |
||
| 746 | public function setDefaultLocale($locale) |
||
| 752 | |||
| 753 | /** |
||
| 754 | * Get the default locale on the model. |
||
| 755 | * |
||
| 756 | * @return mixed |
||
| 757 | */ |
||
| 758 | public function getDefaultLocale() |
||
| 762 | |||
| 763 | /** |
||
| 764 | * Deletes all translations for this model. |
||
| 765 | * |
||
| 766 | * @param string|array|null $locales The locales to be deleted (array or single string) |
||
| 767 | * (e.g., ["en", "de"] would remove these translations). |
||
| 768 | */ |
||
| 769 | public function deleteTranslations($locales = null) |
||
| 785 | |||
| 786 | /** |
||
| 787 | * @param $key |
||
| 788 | * |
||
| 789 | * @return array |
||
| 790 | */ |
||
| 791 | private function getAttributeAndLocale($key) |
||
| 799 | |||
| 800 | /** |
||
| 801 | * @return bool |
||
| 802 | */ |
||
| 803 | private function toArrayAlwaysLoadsTranslations() |
||
| 807 | } |
||
| 808 |
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: