Merge pull request #1 from uofa/WEB-1928-funnelback-upgrade

Funnelback Upgrade - Access Facet Definition
uofa · Jun 13, 2024 · 7201669 · 7201669
2 parents 727bd5a + 7538894
commit 7201669
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 2 deletions.
diff --git a/src/Funnelback/Facet.php b/src/Funnelback/Facet.php
@@ -44,7 +44,7 @@ public function __construct($facet_data)
     {
         $this->facetData = $facet_data;
         $this->name = $facet_data['name'];
-        $this->facetItems = (!empty($facet_data['categories'])) ? $this->buildFacetItems($facet_data['categories'][0]['values']) : [];
+        $this->facetItems = (!empty($facet_data['allValues'])) ? $this->buildFacetItems($facet_data['allValues']) : [];
     }
 
     /**

diff --git a/src/Funnelback/FacetItem.php b/src/Funnelback/FacetItem.php
@@ -52,7 +52,7 @@ public function __construct($facet_item_data)
         $this->facetItemData = $facet_item_data;
         $this->label = $facet_item_data['label'];
         $this->count = $facet_item_data['count'];
-        $this->queryStringParam = $facet_item_data['queryStringParam'];
+        $this->queryStringParam = null;
     }
 
     /**

diff --git a/src/Funnelback/Response.php b/src/Funnelback/Response.php
@@ -43,6 +43,13 @@ class Response
      */
     protected $facets;
 
+     /**
+     * The facets definitions.
+     *
+     * @var array
+     */
+    protected $facetDefinitions;
+
     /**
      * The result summary.
      *
@@ -97,6 +104,10 @@ public function __construct(ResponseInterface $http_response)
         $this->results = $this->buildResults($result_packet['results']);
         $this->facets = $this->buildFacets($response['facets']);
         $this->spelling = $result_packet['spell'];
+
+        $profiles = $this->responseJson['question']['collection']['profiles'];
+        $profileName = array_keys($profiles)[0];
+        $this->facetDefinitions = $this->buildFacetDefinitions($profiles[$profileName]['facetedNavConfConfig']['facetDefinitions']);
     }
 
     /**
@@ -143,6 +154,16 @@ public function getFacets()
         return $this->facets;
     }
 
+    /**
+     * Get the facet definitions
+     *
+     * @return array
+     */
+    public function getFacetDefinitions()
+    {
+        return $this->facetDefinitions;
+    }
+
     /**
      * Gets the best bets.
      *
@@ -221,4 +242,22 @@ protected function buildFacets($facets_data)
         }
         return $facets;
     }
+
+    /**
+     * Builds a list of facet metadata.
+     *
+     * @param array $facets_data
+     *   The raw facet data.
+     *
+     * @return array
+     *   A list of facet metadata
+     */
+    protected function buildFacetDefinitions($facets_data)
+    {
+        $facets = [];
+        foreach ($facets_data as $facet_data) {
+            $facets[$facet_data['name']] = $facet_data;
+        }
+        return $facets;
+    }
 }