AttributeAware::getAttribute() now accepts a default value

Author: clue

lib/Fhaculty/Graph/Attribute/AttributeAware.php

@@ -10,12 +10,13 @@
 interface AttributeAware
 {
     /**
-     * get a single attribute with the given $name
+     * get a single attribute with the given $name (or return $default if attribute was not found)
      *
      * @param string $name
-     * @return mixed|null
+     * @param mixed  $default to return if attribute was not found
+     * @return mixed
      */
-    public function getAttribute($name);
+    public function getAttribute($name, $default = null);
 
     /**
      * set a single attribute with the given $name to given $value

lib/Fhaculty/Graph/Attribute/AttributeBagContainer.php

@@ -6,9 +6,9 @@ class AttributeBagContainer implements AttributeBag
 {
     private $attributes = array();
 
-    public function getAttribute($name)
+    public function getAttribute($name, $default = null)
     {
-        return isset($this->attributes[$name]) ? $this->attributes[$name] : null;
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
     }
 
     public function setAttribute($name, $value)

lib/Fhaculty/Graph/Attribute/AttributeBagNamespaced.php

@@ -19,9 +19,9 @@ public function __construct(AttributeAware $bag, $prefix)
         $this->prefix = $prefix;
     }
 
-    public function getAttribute($name)
+    public function getAttribute($name, $default = null)
     {
-        return $this->bag->getAttribute($this->prefix . $name);
+        return $this->bag->getAttribute($this->prefix . $name, $default);
     }
 
     public function setAttribute($name, $value)

lib/Fhaculty/Graph/Attribute/AttributeBagReference.php

@@ -11,9 +11,9 @@ public function __construct(array &$attributes)
         $this->attributes =& $attributes;
     }
 
-    public function getAttribute($name)
+    public function getAttribute($name, $default = null)
     {
-        return isset($this->attributes[$name]) ? $this->attributes[$name] : null;
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
     }
 
     public function setAttribute($name, $value)

lib/Fhaculty/Graph/Edge/Base.php

@@ -293,9 +293,9 @@ private function __clone()
         // @codeCoverageIgnoreEnd
     }
 
-    public function getAttribute($name)
+    public function getAttribute($name, $default = null)
     {
-        return isset($this->attributes[$name]) ? $this->attributes[$name] : null;
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
     }
 
     public function setAttribute($name, $value)

lib/Fhaculty/Graph/Graph.php

@@ -501,9 +501,9 @@ public function __toString()
         return $this->getExporter()->getOutput($this);
     }
 
-    public function getAttribute($name)
+    public function getAttribute($name, $default = null)
     {
-        return isset($this->attributes[$name]) ? $this->attributes[$name] : null;
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
     }
 
     public function setAttribute($name, $value)

lib/Fhaculty/Graph/Vertex.php

@@ -372,9 +372,9 @@ private function __clone()
         // @codeCoverageIgnoreEnd
     }
 
-    public function getAttribute($name)
+    public function getAttribute($name, $default = null)
     {
-        return isset($this->attributes[$name]) ? $this->attributes[$name] : null;
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
     }
 
     public function setAttribute($name, $value)

tests/Fhaculty/Graph/Attribute/AttributeBagContainerTest.php

@@ -9,6 +9,8 @@ public function testEmpty()
         $bag = new AttributeBagContainer();
 
         $this->assertNull($bag->getAttribute('unknown'));
+        $this->assertEquals('default', $bag->getAttribute('unknown', 'default'));
+
         $this->assertEquals(array(), $bag->getAttributes());
 
         $this->assertSame($bag, $bag->getAttributeBag());

tests/Fhaculty/Graph/Attribute/AttributeBagNamespacedTest.php

@@ -18,6 +18,9 @@ public function testBagContainer()
 
         $this->assertEquals('e', $bag->getAttribute('d'));
 
+        $this->assertNull($bag->getAttribute('unknown'));
+        $this->assertEquals('default', $bag->getAttribute('unknown', 'default'));
+
         $bag->setAttribute('d', 'test');
 
         $this->assertEquals('test', $bag->getAttribute('d'));

tests/Fhaculty/Graph/Attribute/AttributeBagReferenceTest.php

@@ -11,6 +11,8 @@ public function testEmpty()
         $bag = new AttributeBagReference($attributes);
 
         $this->assertNull($bag->getAttribute('unknown'));
+        $this->assertEquals('default', $bag->getAttribute('unknown', 'default'));
+
         $this->assertEquals(array(), $bag->getAttributes());
 
         $this->assertSame($bag, $bag->getAttributeBag());