[PHPAPI-31] Add support for retrieving all facets labels: AfsFacetHelper::get_labels

Author: Charles THIBAULT

AFS/SEARCH/TEST/facetHelperTest.php

@@ -54,6 +54,35 @@ public function testRetrieveFacetLabel()
         $this->assertEquals(AfsFacetType::BOOL_TYPE, $helper->get_type());
         $this->assertEquals(AfsFacetLayout::TREE, $helper->get_layout());
         $this->assertEquals(false, $helper->is_sticky());
+
+        $labels = $helper->get_labels();
+        $this->assertEquals(array("ES" => "Faceta booleana", "FR" => "Facette booléenne", "Boolean facet"), $labels);
+    }
+
+    public function testRetrieveLabelsWhenNoLabelsExists() {
+        $input = json_decode('{
+            "afs:t": "FacetTree",
+            "node": [
+                {
+                    "key": "false",
+                    "labels": [
+                        {
+                            "label": "BAD"
+                        }
+                    ],
+                    "items": 67
+                }
+            ],
+            "layout": "TREE",
+            "type": "BOOL",
+            "id": "FOO",
+             "sticky": "true" }');
+
+        $config = new AfsHelperConfiguration();
+        $helper = new AfsFacetHelper($input, new AfsQuery(), $config);
+        $labels = $helper->get_labels();
+        $this->assertEquals(array("FOO"), $labels);
+        $this->assertEquals("FOO", $helper->get_label());
     }
 
     public function testRetrieveStickyness()

AFS/SEARCH/afs_facet_helper.php

@@ -11,7 +11,7 @@ function is_not_null($value) {
 class AfsFacetHelper extends AfsHelperBase
 {
     private $id = null;
-    private $label = null;
+    private $labels = null;
     private $layout = null;
     private $type = null;
     private $sticky = null;
@@ -28,9 +28,9 @@ public function __construct($facet, AfsQuery $query, AfsHelperConfiguration $con
         $this->id = $facet->id;
         if (property_exists($facet, 'labels') && ! empty($facet->labels)
                 && property_exists($facet->labels[0], 'label')) {
-            $this->label = $facet->labels[0]->label;
+            $this->labels = $facet->labels;
         } else {
-            $this->label = $this->id;
+            $this->labels = null;
         }
         $this->layout = $facet->layout;
         $this->type = $facet->type;
@@ -55,7 +55,32 @@ public function __construct($facet, AfsQuery $query, AfsHelperConfiguration $con
      */
     public function get_label()
     {
-        return $this->label;
+        if (!is_null($this->labels)) {
+            return $this->labels[0]->label;
+        } else {
+            return $this->id;
+        }
+    }
+
+    /** @brief Retrieve all facet labels
+     *
+     * @return labels as a string array
+     */
+    public function get_labels() {
+        $labels = array();
+        if (!is_null($this->labels)) {
+            foreach ($this->labels as $label) {
+                if (property_exists($label, "lang")) {
+                    $labels[$label->lang] = ($label->label);
+                } else {
+                    $labels[] = ($label->label);
+                }
+            }
+        }
+        else {
+            $labels[] = $this->id;
+        }
+        return $labels;
     }
 
     /** @brief Retrieves facet id.