added global search support to YADCFModelMultipleChoiceFilter

Author: matthewhegarty

example/albums/templates/albums/albums.html

@@ -150,8 +150,8 @@ <h4 class="bg-primary text-white p-2" style="margin: 15px;">Example using column
         },
         "columns": [
             {"data": "rank", "searchable": false},
-            {"data": "artist_name", "name": "artist_name",},
-            {"data": "name"},
+            {"data": "artist_name", "name": "artist_name"},
+            {"data": "name", "searchable": false},
         ]
     });
     yadcf.init(albumFilterTable, [

example/albums/views.py

@@ -1,3 +1,4 @@
+from django.db.models import Q
 from django.shortcuts import render
 from django_filters import widgets, fields, filters, NumberFilter, CharFilter
 
@@ -7,6 +8,7 @@
 from rest_framework.views import APIView
 
 from rest_framework_datatables import pagination as dt_pagination
+from rest_framework_datatables.django_filters.filters import GlobalFilter
 from rest_framework_datatables.django_filters.filterset import DatatablesFilterSet
 from rest_framework_datatables.django_filters.backends import DatatablesFilterBackend
 
@@ -77,23 +79,41 @@ class YADCFModelMultipleChoiceField(fields.ModelMultipleChoiceField):
 class YADCFModelMultipleChoiceFilter(filters.ModelMultipleChoiceFilter):
     field_class = YADCFModelMultipleChoiceField
 
+    def global_q(self):
+        """
+        This method is necessary for the global filter
+        - i.e. any string values entered into the search box.
+        """
+        if not self._global_search_value:
+            return Q()
+        kw = "{}__{}".format(self.field_name, self.lookup_expr)
+        return Q(**{kw: self._global_search_value})
+
+
+class GlobalCharFilter(GlobalFilter, filters.CharFilter):
+    pass
+
+
+class GlobalNumberFilter(GlobalFilter, filters.NumberFilter):
+    pass
+
 
 class AlbumFilter(DatatablesFilterSet):
 
-    # the name of this attribute must match the declared 'name' attribute in
+    # the name of this attribute must match the declared 'data' attribute in
     # the DataTables column
     artist_name = YADCFModelMultipleChoiceFilter(
-        field_name="artist", queryset=Artist.objects.all()
+        field_name="artist__name", queryset=Artist.objects.all(), lookup_expr="contains"
     )
 
     # additional attributes need to be declared so that sorting works
     # the field names must match those declared in the DataTables columns.
-    rank = NumberFilter()
-    name = CharFilter()
+    rank = GlobalNumberFilter()
+    name = GlobalCharFilter()
 
     class Meta:
         model = Album
-        fields = ("artist",)
+        fields = ("artist_name", )
 
 
 class AlbumFilterListView(generics.ListAPIView):

rest_framework_datatables/django_filters/filters.py

@@ -52,7 +52,7 @@ class GlobalFilter(SwitchRegexFilter):
     global filtering without using django-filter.
 
     *Must* be used with DjangoFilterBackend which combines the global
-    and colum searches in the correct way and with
+    and column searches in the correct way and with
     DatatablesFilterSet, which ensures that the correct attributes are
     set to make this work.
 
@@ -81,7 +81,7 @@ class GlobalFilter(SwitchRegexFilter):
     """
 
     def global_q(self):
-        """Return a Q-Object for the local search for this column"""
+        """Return a Q-Object for the global search for this column"""
         ret = Q()
         if self.global_search_value:
             ret = Q(**{self.global_lookup: self.global_search_value})