Add general purpose Attributes, replace Layoutable

lib/Fhaculty/Graph/Algorithm/MaximumMatching/Flow.php

@@ -30,8 +30,8 @@ public function getEdges()
         // create temporary flow graph with supersource and supersink
         $graphFlow = $this->graph->createGraphCloneEdgeless();
 
-        $superSource = $graphFlow->createVertex()->setLayoutAttribute('label', 's*');
-        $superSink   = $graphFlow->createVertex()->setLayoutAttribute('label', 't*');
+        $superSource = $graphFlow->createVertex();
+        $superSink   = $graphFlow->createVertex();
 
         $groups = $alg->getGroups();
         $groupA = $groups[0];

lib/Fhaculty/Graph/Algorithm/MinimumCostFlow/CycleCanceling.php

@@ -19,8 +19,8 @@ public function createGraph()
         // create resulting graph with supersource and supersink
         $resultGraph = $this->graph->createGraphClone();
 
-        $superSource = $resultGraph->createVertex()->setLayoutAttribute('label', 's*');
-        $superSink   = $resultGraph->createVertex()->setLayoutAttribute('label', 't*');
+        $superSource = $resultGraph->createVertex();
+        $superSink   = $resultGraph->createVertex();
 
         $sumBalance = 0;
 

lib/Fhaculty/Graph/Attribute/AttributeAware.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Fhaculty\Graph\Attribute;
+
+/**
+ * Implemented by any entity that is aware of additional attributes
+ *
+ * Each attribute consists of a name (string) and an arbitrary value.
+ */
+interface AttributeAware
+{
+    /**
+     * get a single attribute with the given $name (or return $default if attribute was not found)
+     *
+     * @param string $name
+     * @param mixed  $default to return if attribute was not found
+     * @return mixed
+     */
+    public function getAttribute($name, $default = null);
+
+    /**
+     * set a single attribute with the given $name to given $value
+     *
+     * @param string $name
+     * @param mixed  $value
+     */
+    public function setAttribute($name, $value);
+
+    /**
+     * get a container for all attributes
+     *
+     * @return AttributeBag
+     */
+    public function getAttributeBag();
+}

lib/Fhaculty/Graph/Attribute/AttributeBag.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Fhaculty\Graph\Attribute;
+
+/**
+ * Interface to container that represents multiple attributes
+ */
+interface AttributeBag extends AttributeAware
+{
+    // public function getAttribute($name);
+    // public function setAttribute($name, $value);
+    // public function getAttributeBag();
+
+    /**
+     * set an array of additional attributes
+     *
+     * @param array $attributes
+     */
+    public function setAttributes(array $attributes);
+
+    /**
+     * get an array of all attributes
+     *
+     * @return array
+     */
+    public function getAttributes();
+}

lib/Fhaculty/Graph/Attribute/AttributeBagContainer.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Fhaculty\Graph\Attribute;
+
+class AttributeBagContainer implements AttributeBag
+{
+    private $attributes = array();
+
+    public function getAttribute($name, $default = null)
+    {
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
+    }
+
+    public function setAttribute($name, $value)
+    {
+        $this->attributes[$name] = $value;
+
+        return $this;
+    }
+
+    public function getAttributes()
+    {
+        return $this->attributes;
+    }
+
+    public function setAttributes(array $attributes)
+    {
+        $this->attributes = $attributes + $this->attributes;
+
+        return $this;
+    }
+
+    public function getAttributeBag()
+    {
+        return $this;
+    }
+}

lib/Fhaculty/Graph/Attribute/AttributeBagNamespaced.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Fhaculty\Graph\Attribute;
+
+/**
+ * An attribute bag that automatically prefixes a given namespace
+ */
+class AttributeBagNamespaced implements AttributeBag
+{
+    private $bag;
+    private $prefix;
+
+    public function __construct(AttributeAware $bag, $prefix)
+    {
+        if (!($bag instanceof AttributeBag)) {
+            $bag = $bag->getAttributeBag();
+        }
+        $this->bag = $bag;
+        $this->prefix = $prefix;
+    }
+
+    public function getAttribute($name, $default = null)
+    {
+        return $this->bag->getAttribute($this->prefix . $name, $default);
+    }
+
+    public function setAttribute($name, $value)
+    {
+        $this->bag->setAttribute($this->prefix . $name, $value);
+    }
+
+    public function getAttributes()
+    {
+        $attributes = array();
+        $len = strlen($this->prefix);
+
+        foreach ($this->bag->getAttributes() as $name => $value) {
+            if (strpos($name, $this->prefix) === 0) {
+                $attributes[substr($name, $len)] = $value;
+            }
+        }
+
+        return $attributes;
+    }
+
+    public function setAttributes(array $attributes)
+    {
+        foreach ($attributes as $name => $value) {
+            $this->bag->setAttribute($this->prefix . $name, $value);
+        }
+    }
+
+    public function getAttributeBag()
+    {
+        return $this;
+    }
+}

lib/Fhaculty/Graph/Attribute/AttributeBagReference.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Fhaculty\Graph\Attribute;
+
+class AttributeBagReference implements AttributeBag
+{
+    private $attributes;
+
+    public function __construct(array &$attributes)
+    {
+        $this->attributes =& $attributes;
+    }
+
+    public function getAttribute($name, $default = null)
+    {
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
+    }
+
+    public function setAttribute($name, $value)
+    {
+        $this->attributes[$name] = $value;
+
+        return $this;
+    }
+
+    public function getAttributes()
+    {
+        return $this->attributes;
+    }
+
+    public function setAttributes(array $attributes)
+    {
+        $this->attributes = $attributes + $this->attributes;
+
+        return $this;
+    }
+
+    public function getAttributeBag()
+    {
+        return $this;
+    }
+}

lib/Fhaculty/Graph/Edge/Base.php

@@ -2,7 +2,6 @@
 
 namespace Fhaculty\Graph\Edge;
 
-use Fhaculty\Graph\Layoutable;
 use Fhaculty\Graph\Vertex;
 use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Set\Vertices;
@@ -13,8 +12,10 @@
 use Fhaculty\Graph\Exception\UnderflowException;
 use Fhaculty\Graph\Exception\InvalidArgumentException;
 use Fhaculty\Graph\Exception\BadMethodCallException;
+use Fhaculty\Graph\Attribute\AttributeAware;
+use Fhaculty\Graph\Attribute\AttributeBagReference;
 
-abstract class Base extends Layoutable implements VerticesAggregate
+abstract class Base implements VerticesAggregate, AttributeAware
 {
     /**
      * weight of this edge
@@ -40,6 +41,8 @@ abstract class Base extends Layoutable implements VerticesAggregate
      */
     protected $flow = NULL;
 
+    protected $attributes = array();
+
     /**
      * get Vertices that are a target of this edge
      *
@@ -289,4 +292,19 @@ private function __clone()
         throw new BadMethodCallException();
         // @codeCoverageIgnoreEnd
     }
+
+    public function getAttribute($name, $default = null)
+    {
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
+    }
+
+    public function setAttribute($name, $value)
+    {
+        $this->attributes[$name] = $value;
+    }
+
+    public function getAttributeBag()
+    {
+        return new AttributeBagReference($this->attributes);
+    }
 }

lib/Fhaculty/Graph/Graph.php

@@ -21,8 +21,10 @@
 use Fhaculty\Graph\Set\VerticesMap;
 use Fhaculty\Graph\Set\Edges;
 use Fhaculty\Graph\Set\DualAggregate;
+use Fhaculty\Graph\Attribute\AttributeAware;
+use Fhaculty\Graph\Attribute\AttributeBagReference;
 
-class Graph implements DualAggregate
+class Graph implements DualAggregate, AttributeAware
 {
     /**
      * @var ExporterInterface|null
@@ -36,6 +38,8 @@ class Graph implements DualAggregate
     protected $edgesStorage = array();
     protected $edges;
 
+    protected $attributes = array();
+
     public function __construct()
     {
         $this->vertices = VerticesMap::factoryArrayReference($this->verticesStorage);
@@ -100,7 +104,7 @@ public function createVertexClone(Vertex $originalVertex)
         }
         $newVertex = new Vertex($this, $id);
         // TODO: properly set attributes of vertex
-        $newVertex->setLayout($originalVertex->getLayout());
+        $newVertex->getAttributeBag()->setAttributes($originalVertex->getAttributeBag()->getAttributes());
         $newVertex->setBalance($originalVertex->getBalance());
         $newVertex->setGroup($originalVertex->getGroup());
 
@@ -117,7 +121,7 @@ public function createVertexClone(Vertex $originalVertex)
     public function createGraphCloneEdgeless()
     {
         $graph = new Graph();
-//         $graph->setLayout($this->getLayout());
+        $graph->getAttributeBag()->setAttributes($this->getAttributeBag()->getAttributes());
         // TODO: set additional graph attributes
         foreach ($this->getVertices() as $originalVertex) {
             $vertex = $graph->createVertexClone($originalVertex);
@@ -236,7 +240,7 @@ private function createEdgeCloneInternal(Edge $originalEdge, $ia, $ib)
             $newEdge = $a->createEdge($b);
         }
         // TODO: copy edge attributes
-        $newEdge->setLayout($originalEdge->getLayout());
+        $newEdge->getAttributeBag()->setAttributes($originalEdge->getAttributeBag()->getAttributes());
         $newEdge->setWeight($originalEdge->getWeight());
         $newEdge->setFlow($originalEdge->getFlow());
         $newEdge->setCapacity($originalEdge->getCapacity());
@@ -497,8 +501,18 @@ public function __toString()
         return $this->getExporter()->getOutput($this);
     }
 
-    public function getLayout()
+    public function getAttribute($name, $default = null)
+    {
+        return isset($this->attributes[$name]) ? $this->attributes[$name] : $default;
+    }
+
+    public function setAttribute($name, $value)
+    {
+        $this->attributes[$name] = $value;
+    }
+
+    public function getAttributeBag()
     {
-        return array();
+        return new AttributeBagReference($this->attributes);
     }
 }