added README.rst to FlyweightFactory

Dominik Liebler · Dominik Liebler · commit d9d3f1213213 · 2016-04-07T08:53:37.000+02:00
diff --git a/Structural/Flyweight/FlyweightFactory.php b/Structural/Flyweight/FlyweightFactory.php
@@ -12,12 +12,14 @@ class FlyweightFactory
 {
     /**
      * Associative store for flyweight objects
+     * 
      * @var Array
      */
     private $pool = array();
 
     /**
      * Magic getter
+     *
      * @param string $name
      * @return Flyweight
      */
@@ -29,6 +31,9 @@ public function __get($name)
         return $this->pool[$name];
     }
 
+    /**
+     * @return int
+     */
     public function totalNumber()
     {
         return sizeof($this->pool);
diff --git a/Structural/Flyweight/README.rst b/Structural/Flyweight/README.rst
@@ -0,0 +1,51 @@
+`Flyweight`__
+==========
+
+Purpose
+-------
+
+To minimise memory usage, a Flyweight shares as much as possible memory with similar objects. It
+is needed when a large amount of objects is used that don't differ much in state. A common practice is
+to hold state in external data structures and pass them to the flyweight object when needed.
+
+UML Diagram
+-----------
+
+.. image:: uml/uml.png
+   :alt: Alt Facade UML Diagram
+   :align: center
+
+Code
+----
+
+You can also find these code on `GitHub`_
+
+FlyweightInterface.php
+
+.. literalinclude:: FlyweightInterface.php
+   :language: php
+   :linenos:
+
+CharacterFlyweight.php
+
+.. literalinclude:: CharacterFlyweight.php
+   :language: php
+   :linenos:
+
+FlyweightFactory.php
+
+.. literalinclude:: FlyweightFactory.php
+   :language: php
+   :linenos:
+
+Test
+----
+
+Tests/FlyweightTest.php
+
+.. literalinclude:: Tests/FlyweightTest.php
+   :language: php
+   :linenos:
+
+.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/master/Structural/Flyweight
+.. __: https://en.wikipedia.org/wiki/Flyweight_pattern
