Add support for transOrderBy

behaviors/TranslatableModel.php

@@ -23,7 +23,7 @@ class TranslatableModel extends TranslatableBehavior
 {
     /**
      * Applies a translatable index to a basic query. This scope will join the index
-     * table and cannot be executed more than once.
+     * table and can be executed neither more than once, nor with scopeTransOrder.
      * @param  Builder $query
      * @param  string $index
      * @param  string $value
@@ -32,10 +32,6 @@ class TranslatableModel extends TranslatableBehavior
      */
     public function scopeTransWhere($query, $index, $value, $locale = null, $operator = '=')
     {
-        if (!$locale) {
-            $locale = $this->translatableContext;
-        }
-
         $query->select($this->model->getTable().'.*');
 
         $query->where(function($q) use ($index, $value, $operator) {
@@ -48,6 +44,47 @@ public function scopeTransWhere($query, $index, $value, $locale = null, $operato
             });
         });
 
+        $this->joinTranslateIndexesTable($query, $locale);
+
+        return $query;
+    }
+
+    /**
+     * Applies a sort operation with a translatable index to a basic query. This scope will join the index
+     * table and can be executed neither more than once, nor with scopeTransWhere.
+     * @param  Builder $query
+     * @param  string $index
+     * @param  string $direction
+     * @param  string $locale
+     * @return Builder
+     */
+    public function scopeTransOrderBy($query, $index, $direction = 'asc', $locale = null)
+    {
+        $query->select(
+            $this->model->getTable().'.*',
+            Db::raw('COALESCE(rainlab_translate_indexes.value, '. $this->model->getTable() .'.'.$index.') AS translate_sorting_key')
+        );
+
+        $query->orderBy('translate_sorting_key', $direction);
+
+        $this->joinTranslateIndexesTable($query, $locale);
+
+        return $query;
+    }
+
+    /**
+     * Joins the translatable indexes table to a query.
+     * This cannot be executed more than once.
+     * @param  Builder $query
+     * @param  string $locale
+     * @return Builder
+     */
+    protected function joinTranslateIndexesTable($query, $locale = null)
+    {
+        if (!$locale) {
+            $locale = $this->translatableContext;
+        }
+
         // This join will crap out if this scope executes twice, it is a known issue.
         // It should check if the join exists before applying it, this mechanism was
         // not found in Laravel. So options are block joins entirely or allow once.

tests/fixtures/models/Country.php

@@ -9,7 +9,7 @@ class Country extends Model
 {
     public $implement = ['@RainLab.Translate.Behaviors.TranslatableModel'];
 
-    public $translatable = ['name', 'states'];
+    public $translatable = [['name', 'index' => true], 'states'];
 
     /**
      * @var string The database table used by the model.

tests/unit/behaviors/TranslatableModelTest.php

@@ -3,6 +3,7 @@
 use Schema;
 use PluginTestCase;
 use Model;
+use RainLab\Translate\Classes\Translator;
 use RainLab\Translate\Tests\Fixtures\Models\Country as CountryModel;
 use RainLab\Translate\Models\Locale as LocaleModel;
 
@@ -101,4 +102,52 @@ public function testSetTranslationValue()
         $this->assertEquals(['a', 'b', 'c'], $obj->states);
     }
 
+    public function testTranslateWhere()
+    {
+        $this->recycleSampleData();
+
+        $obj = CountryModel::first();
+
+        $obj->translateContext('fr');
+        $obj->name = 'Australie';
+        $obj->save();
+
+        $this->assertEquals(0, CountryModel::transWhere('name', 'Australie')->count());
+
+        Translator::instance()->setLocale('fr');
+        $this->assertEquals(1, CountryModel::transWhere('name', 'Australi')->count());
+
+        Translator::instance()->setLocale('en');
+
+    }
+
+    public function testTranslateOrderBy()
+    {
+        $this->recycleSampleData();
+
+        $obj = CountryModel::first();
+
+        $obj->translateContext('fr');
+        $obj->name = 'Australie';
+        $obj->save();
+
+        $obj = CountryModel::create([
+            'name' => 'Germany',
+            'code' => 'DE'
+        ]);
+
+        $obj->translateContext('fr');
+        $obj->name = 'Allemagne';
+        $obj->save();
+
+        $res = CountryModel::transOrderBy('name')->get()->pluck('name');
+        $this->assertEquals(['Australia', 'Germany'], $res->toArray());
+
+        Translator::instance()->setLocale('fr');
+        $res = CountryModel::transOrderBy('name')->get()->pluck('name');
+        $this->assertEquals(['Allemagne', 'Australie'], $res->toArray());
+
+        Translator::instance()->setLocale('en');
+    }
+
 }