Merge pull request #72 from Lloople/order_by_locale

Get all translations when ordering by locale

Author: Gummibeer

src/Translatable/Traits/Scopes.php

@@ -56,14 +56,14 @@ public function scopeOrderByTranslation(Builder $query, string $translationField
         $keyName = $this->getKeyName();
 
         return $query
-            ->join($translationTable, function (JoinClause $join) use ($translationTable, $localeKey, $table, $keyName) {
+            ->with('translations')
+            ->select("{$table}.*")
+            ->leftJoin($translationTable, function (JoinClause $join) use ($translationTable, $localeKey, $table, $keyName) {
                 $join
-                    ->on($translationTable.'.'.$this->getTranslationRelationKey(), '=', $table.'.'.$keyName)
-                    ->where($translationTable.'.'.$localeKey, $this->locale());
+                    ->on("{$translationTable}.{$this->getTranslationRelationKey()}", '=', "{$table}.{$keyName}")
+                    ->where("{$translationTable}.{$localeKey}", $this->locale());
             })
-            ->orderBy($translationTable.'.'.$translationField, $sortMethod)
-            ->select($table.'.*')
-            ->with('translations');
+            ->orderBy("{$translationTable}.{$translationField}", $sortMethod);
     }
 
     public function scopeOrWhereTranslation(Builder $query, string $translationField, $value, ?string $locale = null)

tests/ScopesTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Astrotomic\Translatable\Test\Model\Food;
 use Astrotomic\Translatable\Test\Model\Country;
 use Astrotomic\Translatable\Test\Model\Vegetable;
 
@@ -203,12 +204,26 @@ public function test_whereTranslationLike_filters_by_translation_and_locale()
     public function test_orderByTranslation_sorts_by_key_asc()
     {
         $result = Country::orderByTranslation('name')->get();
-        $this->assertSame(2, $result->first()->id);
+        $this->assertSame(3, $result->first()->id);
     }
 
     public function test_orderByTranslation_sorts_by_key_desc()
     {
         $result = Country::orderByTranslation('name', 'desc')->get();
         $this->assertSame(1, $result->first()->id);
     }
+
+    public function test_orderByTranslation_sorts_by_key_asc_even_if_locale_is_missing()
+    {
+        Food::create(['en' => ['name' => 'Potatoes'], 'fr' => ['name' => 'Pommes de Terre']]);
+        Food::create(['en' => ['name' => 'Strawberries'], 'fr' => ['name' => 'Fraises']]);
+        Food::create([]);
+
+        $orderInEnglish = Food::with('translations')->orderByTranslation('name')->get();
+        $this->assertEquals([null, 'Potatoes', 'Strawberries'], $orderInEnglish->pluck('name')->toArray());
+
+        App::setLocale('fr');
+        $orderInFrench = Food::with('translations')->orderByTranslation('name', 'desc')->get();
+        $this->assertEquals(['Pommes de Terre', 'Fraises', null], $orderInFrench->pluck('name')->toArray());
+    }
 }