Fix custom field orderby with legacy field data

Author: bryannielsen

CHANGELOG.md

@@ -12,6 +12,7 @@
 - Generic fieldtype passes `content_id` along to core fieldtype handler and triggers `pre_process` hook.
 - Error checking and handling for GraphQL compatible fieldtypes
 - Trigger `core_boot` hook during GraphQL requests
+- Custom field orderby clauses when it uses legacy field data storage
 
 ## [1.1.2] - 2023-07-27
 

src/Models/Addon/Fluid/Data.php

@@ -42,7 +42,7 @@ public function scopeCustomFields($query, $fields = null)
 
         // Get a set of table names for fields that do not store data on the legacy table
         $fields = $fields->filter(function ($field) {
-            return $field->legacy_field_data === 'n' || $field->legacy_field_data === false || $field->hasDataTable();
+            return ! $field->hasLegacyFieldData() || $field->hasDataTable();
         });
 
         // Join these extra field data tables

src/Models/Category/Category.php

@@ -4,6 +4,7 @@
 
 use Expressionengine\Coilpack\FieldtypeManager;
 use Expressionengine\Coilpack\Model;
+use Expressionengine\Coilpack\Models\Channel\ChannelData;
 use Expressionengine\Coilpack\Models\Channel\ChannelEntry;
 use Expressionengine\Coilpack\Models\FieldContent;
 
@@ -46,28 +47,30 @@ public function scopeOrderByCustomField($query, $field, $direction = 'asc')
         $field = $manager->getField($field, 'category');
         $column = "field_id_{$field->field_id}";
 
-        // If this field is not storing it's data on the category_field_data table we
-        // will join the separate data table with a unique orderby_field_name alias
-        if ($field->legacy_field_data === 'n' || $field->legacy_field_data === false) {
-            $alias = "orderby_{$field->field_name}";
-            $column = "$alias.$column";
-            $this->scopeJoinFieldDataTable($query, $field, $alias);
-        }
+        // Setup our join for the appropriate channel data table and alias
+        $alias = $field->hasLegacyFieldData() ? 'orderby_legacy_data' : "orderby_{$field->field_name}";
+        $this->scopeJoinFieldDataTable($query, $field, $alias);
+        $query->select($this->qualifyColumn('*'));
 
-        return $query->orderBy($column, $direction);
+        return $query->orderBy("$alias.$column", $direction);
     }
 
     public function scopeJoinFieldDataTable($query, $field, $alias = null)
     {
-        if ($field->legacy_field_data == 'y' || $field->legacy_field_data === true) {
+        // If we have already joined this table alias just do nothing
+        $alreadyJoined = collect($query->getQuery()->joins)->pluck('table')->contains(function ($joinTable) use ($alias) {
+            return strpos($joinTable, $alias) !== false;
+        });
+
+        if ($alreadyJoined) {
             return $query;
         }
 
-        $table = $field->data_table_name;
+        $table = $field->hasLegacyFieldData() ? (new ChannelData)->getTable() : $field->data_table_name;
         $joinTable = $alias ? "$table as $alias" : $table;
         $alias = $alias ?: $table;
         $query->leftJoin($joinTable, "$alias.cat_id", '=', $this->qualifyColumn('cat_id'));
-        $query->select('*', $this->qualifyColumn('cat_id'));
+        $query->select($this->qualifyColumn('*'));
 
         return $query;
     }

src/Models/Category/CategoryData.php

@@ -32,7 +32,7 @@ public function scopeCustomFields($query, $fields = null)
 
         // Get a set of table names for fields that do not store data on the legacy table
         $fieldtypeTables = $fields->filter(function ($field) {
-            return $field->legacy_field_data === 'n' || $field->legacy_field_data === false;
+            return ! $field->hasLegacyFieldData();
         })->map(function ($field) {
             return $field->data_table_name;
         });

src/Models/Channel/ChannelData.php

@@ -32,7 +32,7 @@ public function scopeCustomFields($query, $fields = null)
 
         // Get a set of table names for fields that do not store data on the legacy table
         $fieldtypeTables = $fields->filter(function ($field) {
-            return $field->legacy_field_data === 'n' || $field->legacy_field_data === false;
+            return ! $field->hasLegacyFieldData();
         })->map(function ($field) {
             return $field->data_table_name;
         });

src/Models/Channel/ChannelEntry.php

@@ -132,28 +132,30 @@ public function scopeOrderByCustomField($query, $field, $direction = 'asc')
         $field = $manager->getField($field);
         $column = "field_id_{$field->field_id}";
 
-        // If this field is not storing it's data on the channel_data table we
-        // will join the separate data table with a unique orderby_field_name alias
-        if ($field->legacy_field_data === 'n' || $field->legacy_field_data === false) {
-            $alias = "orderby_{$field->field_name}";
-            $column = "$alias.$column";
-            $this->scopeJoinFieldDataTable($query, $field, $alias);
-        }
+        // Setup our join for the appropriate channel data table and alias
+        $alias = $field->hasLegacyFieldData() ? 'orderby_legacy_data' : "orderby_{$field->field_name}";
+        $this->scopeJoinFieldDataTable($query, $field, $alias);
+        $query->select($this->qualifyColumn('*'));
 
-        return $query->orderBy($column, $direction);
+        return $query->orderBy("$alias.$column", $direction);
     }
 
     public function scopeJoinFieldDataTable($query, $field, $alias = null)
     {
-        if ($field->legacy_field_data == 'y' || $field->legacy_field_data === true) {
+        // If we have already joined this table alias just do nothing
+        $alreadyJoined = collect($query->getQuery()->joins)->pluck('table')->contains(function ($joinTable) use ($alias) {
+            return strpos($joinTable, $alias) !== false;
+        });
+
+        if ($alreadyJoined) {
             return $query;
         }
 
-        $table = $field->data_table_name;
+        $table = $field->hasLegacyFieldData() ? (new ChannelData)->getTable() : $field->data_table_name;
         $joinTable = $alias ? "$table as $alias" : $table;
         $alias = $alias ?: $table;
         $query->leftJoin($joinTable, "$alias.entry_id", '=', $this->qualifyColumn('entry_id'));
-        $query->select('*', $this->qualifyColumn('entry_id'));
+        $query->select($this->qualifyColumn('*'));
 
         return $query;
     }

src/Models/Channel/ChannelField.php

@@ -75,4 +75,9 @@ public function getGraphType()
     {
         return $this->getFieldType()->getGraphType($this);
     }
+
+    public function hasLegacyFieldData()
+    {
+        return $this->legacy_field_data === 'y' || $this->legacy_field_data === true;
+    }
 }

src/Models/Member/MemberData.php

@@ -33,7 +33,7 @@ public function scopeCustomFields($query, $fields = null)
 
         // Get a set of table names for fields that do not store data on the legacy table
         $fieldtypeTables = $fields->filter(function ($field) {
-            return $field->m_legacy_field_data === false || $field->m_legacy_field_data === 'n';
+            return ! $field->hasLegacyFieldData();
         })->map(function ($field) {
             return $field->data_table_name;
         });

src/Models/Member/MemberField.php

@@ -36,4 +36,9 @@ public function getDataTableNameAttribute($value)
     {
         return "member_data_field_{$this->m_field_id}";
     }
+
+    public function hasLegacyFieldData()
+    {
+        return $this->m_legacy_field_data === 'y' || $this->m_legacy_field_data === true;
+    }
 }

src/Traits/DataAcrossTables.php

@@ -20,7 +20,7 @@ public function scopeCustomFields($query, $fields = null)
 
         // Get a set of table names for fields that do not store data on the legacy table
         $fieldtypeTables = $fields->filter(function ($field) {
-            return $field->legacy_field_data === 'n' || $field->legacy_field_data === false;
+            return ! $field->hasLegacyFieldData();
         })->map(function ($field) {
             return $field->data_table_name;
         });