Merge pull request #157 from froboy/MAINTAIN-191-limit-by-category

Implement "limit by category" in AF4

Author: podarok

openy_af4_vue_app/.nvmrc

@@ -0,0 +1 @@
+v14.18.1

openy_af4_vue_app/dist/activity_finder_4.umd.min.js

@@ -48,6 +48,7 @@
           :filters-section-config="filtersSectionConfig"
           :daxko="daxko"
           :bs-version="bsVersion"
+          :limit-by-category="limitByCategory"
           :exclude-by-category="excludeByCategory"
           :exclude-by-location="excludeByLocation"
           @filterChange="onFilterChange($event, hideModal)"
@@ -141,6 +142,7 @@
       :facets="data.facets.field_activity_category"
       :first-step="selectedPath === 'selectActivities'"
       :multiple="!daxko"
+      :limit-by-category="limitByCategory"
       :exclude-by-category="excludeByCategory"
       @nextStep="nextStep('selectActivities')"
     />
@@ -185,6 +187,7 @@
           :filters-section-config="filtersSectionConfig"
           :daxko="daxko"
           :bs-version="bsVersion"
+          :limit-by-category="limitByCategory"
           :exclude-by-category="excludeByCategory"
           :exclude-by-location="excludeByLocation"
           filters-mode="instant"
@@ -509,6 +512,7 @@ export default {
         page: this.selectedPage,
         sort: this.selectedSort,
         keywords: this.searchKeywords,
+        limit: this.limitByCategory.join(','),
         exclude: this.excludeByCategory.join(','),
         excludeloc: this.excludeByLocation.join(',')
       }
@@ -857,6 +861,7 @@ export default {
         .request({
           params: {
             locations: this.homeBranchId,
+            limit: this.searchParams.limit,
             exclude: this.searchParams.exclude
           }
         })

openy_af4_vue_app/package-lock.json

@@ -56,6 +56,10 @@ export default {
       type: Boolean,
       default: true
     },
+    limitByCategory: {
+      type: Array,
+      required: true
+    },
     excludeByCategory: {
       type: Array,
       required: true
@@ -68,21 +72,27 @@ export default {
   },
   computed: {
     filteredActivities() {
-      if (!this.excludeByCategory.length) {
+      if (!this.excludeByCategory.length && !this.limitByCategory.length) {
         return this.activities
       }
 
       const filteredActivities = {}
       this.activities.forEach((activityGroup, key) => {
-        // Filter out excluded categories.
-        if (!this.excludeByCategory.length) {
-          filteredActivities[key] = activityGroup
-          return
-        }
-
         const filteredValue = activityGroup.value.filter(item => {
-          return !this.excludeByCategory.includes(item.value.toString())
+          let r = false
+          // Items must pass both tests, so we intentionally do not ELSE these.
+          // If there are excludes, the item must NOT be excluded.
+          if (this.excludeByCategory.length) {
+            r = !this.excludeByCategory.includes(item.value.toString())
+          }
+          // If there are limits, ONLY items in the limit list are included.
+          if (this.limitByCategory.length) {
+            r = this.limitByCategory.includes(item.value.toString())
+          }
+          return r
         })
+        // If there are no filtered values then the activityGroup is empty,
+        // and we should not add it to the filteredActivities array.
         if (!filteredValue.length) {
           return
         }

openy_af4_vue_app/src/App.vue

@@ -59,6 +59,7 @@
           :activities="activities"
           :facets="data.facets.field_activity_category"
           :multiple="!daxko"
+          :limit-by-category="limitByCategory"
           :exclude-by-category="excludeByCategory"
         />
       </Fieldset>
@@ -194,6 +195,10 @@ export default {
       type: Boolean,
       default: false
     },
+    limitByCategory: {
+      type: Array,
+      required: true
+    },
     excludeByCategory: {
       type: Array,
       required: true

openy_af4_vue_app/src/components/filters/Activities.vue

@@ -85,6 +85,10 @@ export default {
       type: Boolean,
       default: true
     },
+    limitByCategory: {
+      type: Array,
+      required: true
+    },
     excludeByCategory: {
       type: Array,
       required: true
@@ -97,7 +101,7 @@ export default {
   },
   computed: {
     filteredActivities() {
-      if (!this.firstStep && !this.excludeByCategory.length) {
+      if (!this.firstStep && !this.excludeByCategory.length && !this.limitByCategory.length) {
         return this.activities
       }
 
@@ -108,15 +112,21 @@ export default {
           return
         }
 
-        // Filter out excluded categories.
-        if (!this.excludeByCategory.length) {
-          filteredActivities[key] = activityGroup
-          return
-        }
-
         const filteredValue = activityGroup.value.filter(item => {
-          return !this.excludeByCategory.includes(item.value.toString())
+          let r = false
+          // Items must pass both tests, so we intentionally do not ELSE these.
+          // If there are excludes, the item must NOT be excluded.
+          if (this.excludeByCategory.length) {
+            r = !this.excludeByCategory.includes(item.value.toString())
+          }
+          // If there are limits, ONLY items in the limit list are included.
+          if (this.limitByCategory.length) {
+            r = this.limitByCategory.includes(item.value.toString())
+          }
+          return r
         })
+        // If there are no filtered values then the activityGroup is empty,
+        // and we should not add it to the filteredActivities array.
         if (!filteredValue.length) {
           return
         }

openy_af4_vue_app/src/components/filters/Filters.vue

@@ -240,6 +240,24 @@ public function doSearchRequest($parameters) {
       $query->addCondition('field_category_program', $program_types, 'IN');
     }
 
+    // Limit categories.
+    $limit_nids = [];
+    if (!empty($parameters['limit'])) {
+      $limit_nids = explode(',', $parameters['limit']);
+    }
+    $limit_nids_config = explode(',', $this->config->get('limit'));
+    $limit_nids = array_merge($limit_nids, $limit_nids_config);
+    $limit_categories = [];
+    foreach ($limit_nids as $nid) {
+      if (empty($category_program_info[$nid]['title'])) {
+        continue;
+      }
+      $limit_categories[] = $nid;
+    }
+    if ($limit_categories) {
+      $query->addCondition('field_activity_category', $limit_categories, 'IN');
+    }
+
     // Ensure to exclude categories.
     $exclude_nids = [];
     if (!empty($parameters['exclude'])) {