[APIPHP-29] Add support for retrieving facet tags

Author: Charles THIBAULT

AFS/SEARCH/TEST/facetHelperTest.php

@@ -85,6 +85,65 @@ public function testRetrieveLabelsWhenNoLabelsExists() {
         $this->assertEquals("FOO", $helper->get_label());
     }
 
+    public function testRetrieveTags() {
+        $input = json_decode('{
+            "afs:t": "FacetTree",
+            "tags": "tag1 tag2 tag3",
+            "node": [
+                {
+                    "key": "false",
+                    "labels": [
+                        {
+                            "label": "BAD"
+                        }
+                    ],
+                    "items": 67
+                }
+            ],
+            "layout": "TREE",
+            "type": "BOOL",
+            "id": "FOO",
+            "labels": [
+                {
+                    "label": "String facet"
+                }
+             ],
+             "sticky": "true" }');
+
+        $config = new AfsHelperConfiguration();
+        $helper = new AfsFacetHelper($input, new AfsQuery(), $config);
+        $this->assertEquals(array('tag1', 'tag2', 'tag3'), $helper->get_tags());
+    }
+
+    public function testNotags() {
+        $input = json_decode('{
+            "afs:t": "FacetTree",
+            "node": [
+                {
+                    "key": "false",
+                    "labels": [
+                        {
+                            "label": "BAD"
+                        }
+                    ],
+                    "items": 67
+                }
+            ],
+            "layout": "TREE",
+            "type": "BOOL",
+            "id": "FOO",
+            "labels": [
+                {
+                    "label": "String facet"
+                }
+             ],
+             "sticky": "true" }');
+
+        $config = new AfsHelperConfiguration();
+        $helper = new AfsFacetHelper($input, new AfsQuery(), $config);
+        $this->assertEquals(array(), $helper->get_tags());
+    }
+
     public function testRetrieveStickyness()
     {
         $input = json_decode('{

AFS/SEARCH/afs_facet_helper.php

@@ -12,6 +12,7 @@ class AfsFacetHelper extends AfsHelperBase
 {
     private $id = null;
     private $labels = null;
+    private $tags = null;
     private $layout = null;
     private $type = null;
     private $sticky = null;
@@ -26,12 +27,13 @@ class AfsFacetHelper extends AfsHelperBase
     public function __construct($facet, AfsQuery $query, AfsHelperConfiguration $config, $feed=null)
     {
         $this->id = $facet->id;
-        if (property_exists($facet, 'labels') && ! empty($facet->labels)
-                && property_exists($facet->labels[0], 'label')) {
+        if (property_exists($facet, 'labels') && ! empty($facet->labels)) {
             $this->labels = $facet->labels;
-        } else {
-            $this->labels = null;
         }
+        if (property_exists($facet, 'tags')) {
+            $this->tags = $facet->tags;
+        }
+
         $this->layout = $facet->layout;
         $this->type = $facet->type;
         if (property_exists($facet, 'sticky')
@@ -83,6 +85,18 @@ public function get_labels() {
         return $labels;
     }
 
+    /** @brief Retrieve current facet tags
+     *
+     * @return tags as a string array or empty array if current facet have no tags
+     */
+    public function get_tags() {
+        if (! is_null($this->tags)) {
+            return explode(' ', $this->tags);
+        }
+
+        return array();
+    }
+
     /** @brief Retrieves facet id.
      *
      * This value is not necessary unless specific query should be created