Merge pull request #3 from baldurrensch/templated_links

Templated links and empty resources
zircote · Oct 29, 2012 · 83d4845 · 83d4845
2 parents 82e0c3f + 9723bd3
commit 83d4845
Show file tree

Hide file tree

Showing 7 changed files with 194 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+vendor/
diff --git a/composer.json b/composer.json
@@ -17,6 +17,9 @@
     "require": {
         "php": ">=5.3.3"
     },
+    "require-dev": {
+        "phpunit/phpunit": "3.7.*"
+    },
     "autoload": {
         "psr-0": {"Hal": "library"}
     }

diff --git a/composer.lock b/composer.lock
diff --git a/library/Hal/Link.php b/library/Hal/Link.php
@@ -68,21 +68,31 @@ class Link extends AbstractHal
      * @var string
      */
     protected $_hreflang;
+
+    /**
+     * Whether this link is "templated"
+     * @var boolean
+     * @link https://tools.ietf.org/html/rfc6570
+     */
+    protected $_templated;
+
     /**
      *
      * @param string $href
      * @param string $rel
      * @param string $title
      * @param string $name
      * @param string $hreflang
+     * @param boolean $templated
      */
-    public function __construct($href, $rel = 'self', $title = null, $name = null, $hreflang = null)
+    public function __construct($href, $rel = 'self', $title = null, $name = null, $hreflang = null, $templated = false)
     {
         $this->setHref($href)
             ->setRel($rel)
             ->setName($name)
             ->setTitle($title)
-            ->setHreflang($hreflang);
+            ->setHreflang($hreflang)
+            ->setTemplated($templated);
     }
     /**
      * @return string
@@ -122,6 +132,15 @@ public function getHreflang ()
     {
         return $this->_hreflang;
     }
+
+    /**
+     * @return boolean
+     */
+    public function getTemplated()
+    {
+        return $this->_templated;
+    }
+
     /**
      * @param string $rel
      * @return Link
@@ -169,6 +188,17 @@ public function setHreflang ($hreflang)
         $this->_hreflang = $hreflang;
         return $this;
     }
+
+    /**
+     * @param boolean $templated
+     * @return Link
+     */
+    public function setTemplated($templated)
+    {
+        $this->_templated = $templated;
+        return $this;
+    }
+
     /**
      *
      * @return array
@@ -188,6 +218,9 @@ public function toArray()
         if($this->getHreflang()){
             $link['hreflang'] = $this->getHreflang();
         }
+        if ($this->getTemplated()) {
+            $link['templated'] = $this->getTemplated();
+        }
         return $link;
     }
 }
diff --git a/library/Hal/Resource.php b/library/Hal/Resource.php
@@ -136,7 +136,7 @@ public function setData($rel, $data = null)
      * @param Resource $resource
      * @return Resource
      */
-    public function setEmbedded($rel,Resource $resource, $singular = false)
+    public function setEmbedded($rel,Resource $resource = null, $singular = false)
     {
         if($singular){
             $this->_embedded[$rel] = $resource;

diff --git a/tests/library/Hal/LinkTest.php b/tests/library/Hal/LinkTest.php
@@ -405,5 +405,82 @@ public function testSimple()
             json_decode($fixture), json_decode((string)$parent)
         );
     }
+
+    public function testTemplatedLink()
+    {
+        $fixture = <<<'EOF'
+{
+    "_links":{
+        "self":{
+            "href":"/dogs"
+        },
+        "search":{
+            "href":"/dogs?q={text}",
+            "templated": true
+        }
+    }, "_embedded":{
+        "dog":[
+            {
+                "_links":{
+                    "self":{
+                        "href":"/dogs\/1"
+                    }
+                },
+                "id":"1",
+                "name":"tiber",
+                "color":"black"
+            },
+            {
+                "_links":{
+                    "self":{
+                        "href":"/dogs\/2"
+                    }
+                },
+                "id":"2",
+                "name":"sally",
+                "color":"white"
+            },
+            {
+                "_links":{
+                    "self":{
+                        "href":"/dogs\/3"
+                    }
+                },
+                "id":"3",
+                "name":"fido",
+                "color":"gray"
+            }
+        ]
+    }
+}
+EOF;
+
+        $parent = new Resource('/dogs');
+        /* Add any relevent links */
+        $parent->setLink(new Link('/dogs?q={text}', 'search', null, null, null, true));
+        $dogs[1] = new Resource('/dogs/1');
+        $dogs[1]->setData(
+            array('id' => '1', 'name' => 'tiber', 'color' => 'black')
+        );
+        $dogs[2] = new Resource('/dogs/2', array(
+                                                'id'    => '2',
+                                                'name'  => 'sally',
+                                                'color' => 'white'
+                                           ));
+        $dogs[3] = new Resource('/dogs/3', array(
+                                                'id'    => '3',
+                                                'name'  => 'fido',
+                                                'color' => 'gray'
+                                           ));
+        /* Add the embedded resources */
+        foreach ($dogs as $dog) {
+            $parent->setEmbedded('dog', $dog);
+        }
+
+        $this->assertEquals(
+            json_decode($fixture), json_decode((string)$parent)
+        );
+
+    }
 }
 
diff --git a/tests/library/Hal/ResourceTest.php b/tests/library/Hal/ResourceTest.php
@@ -160,4 +160,34 @@ public function testSetLinksMultipleSingluar()
         $expected = json_decode($JSON);
         $this->assertEquals($expected, $actual);
     }
+
+    /**
+     * This tests adding an empty resource
+     */
+    public function testEmptyResource()
+    {
+        $fixture = <<<'EOF'
+{
+    "_links":{
+        "self":{
+            "href":"/dogs"
+        },
+        "search":{
+            "href":"/dogs?q={text}"
+        }
+    }, "_embedded":{
+        "dog":[]
+    }
+}
+EOF;
+
+        $parent = new Resource('/dogs');
+        $parent->setLink(new Link('/dogs?q={text}', 'search'));
+
+        $parent->setEmbedded('dog', null);
+
+        $this->assertEquals(
+            json_decode($fixture), json_decode((string)$parent)
+        );
+    }
 }