From d97f9831d5496e284965e7903365221b921aa605 Mon Sep 17 00:00:00 2001
From: janukobytsch <janusch.jacoby@student.hpi.uni-potsdam.de>
Date: Mon, 2 Feb 2015 00:11:48 +0100
Subject: [PATCH] added flyweight pattern

---
 Structural/Flyweight/CharacterFlyweight.php  | 36 +++++++++++++++++++
 Structural/Flyweight/FlyweightFactory.php    | 37 ++++++++++++++++++++
 Structural/Flyweight/FlyweightInterface.php  | 12 +++++++
 Structural/Flyweight/Tests/FlyweightTest.php | 36 +++++++++++++++++++
 4 files changed, 121 insertions(+)
 create mode 100644 Structural/Flyweight/CharacterFlyweight.php
 create mode 100644 Structural/Flyweight/FlyweightFactory.php
 create mode 100644 Structural/Flyweight/FlyweightInterface.php
 create mode 100644 Structural/Flyweight/Tests/FlyweightTest.php

diff --git a/Structural/Flyweight/CharacterFlyweight.php b/Structural/Flyweight/CharacterFlyweight.php
new file mode 100644
index 0000000..77d6b2d
--- /dev/null
+++ b/Structural/Flyweight/CharacterFlyweight.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace DesignPatterns\Structural\Flyweight;
+
+/**
+ * Implements the flyweight interface and adds storage for intrinsic state, if any.
+ * Instances of concrete flyweights are shared by means of a factory.
+ */
+class CharacterFlyweight implements FlyweightInterface {
+
+	/**
+	 * Any state stored by the concrete flyweight must be independent of its context.
+	 * For flyweights representing characters, this is usually the corresponding character code.
+	 * @var string
+	 */
+	private $name;
+
+	/**
+	 * Constructor.
+	 * @param string $name
+	 */
+	public function __construct($name) {
+		$this->name = $name;
+	}
+
+	/**
+	 * Clients supply the context-dependent information that the flyweight needs to draw itself
+	 * For flyweights representing characters, extrinsic state usually contains e.g. the font
+	 * @param string $font
+	 */
+	public function draw($font)
+	{
+		print_r("Character {$this->name} printed $font \n");
+	}
+
+}
\ No newline at end of file
diff --git a/Structural/Flyweight/FlyweightFactory.php b/Structural/Flyweight/FlyweightFactory.php
new file mode 100644
index 0000000..4558300
--- /dev/null
+++ b/Structural/Flyweight/FlyweightFactory.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace DesignPatterns\Structural\Flyweight;
+
+use DesignPatterns\Structural\Flyweight\CharacterFlyweight;
+
+/**
+ * A factory manages shared flyweights. Clients shouldn't instaniate them directly,
+ * but let the factory take care of returning existing objects or creating new ones.
+ */
+class FlyweightFactory {
+	
+	/**
+	 * Associative store for flyweight objects
+     * @var Array
+     */
+	private $pool = array();
+
+	/**
+     * Magic getter
+     * @param string $name
+     * @return Flyweight
+     */
+    public function __get($name)
+    {
+        if (!array_key_exists((string) $name, $this->pool)) {
+            $this->pool[(string) $name] = new CharacterFlyweight((string) $name);
+        }
+        return $this->pool[(string) $name];
+    }
+
+    public function totalNumber()
+    {
+    	return sizeof($this->pool);
+    }
+
+}
\ No newline at end of file
diff --git a/Structural/Flyweight/FlyweightInterface.php b/Structural/Flyweight/FlyweightInterface.php
new file mode 100644
index 0000000..cf43d57
--- /dev/null
+++ b/Structural/Flyweight/FlyweightInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace DesignPatterns\Structural\Flyweight;
+
+/**
+ * An interface through which flyweights can receive and act on extrinsic state
+ */
+interface FlyweightInterface {
+
+	public function draw($extrinsicState);
+
+}
\ No newline at end of file
diff --git a/Structural/Flyweight/Tests/FlyweightTest.php b/Structural/Flyweight/Tests/FlyweightTest.php
new file mode 100644
index 0000000..ade3fde
--- /dev/null
+++ b/Structural/Flyweight/Tests/FlyweightTest.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace DesignPatterns\Structural\Flyweight\Tests;
+
+use DesignPatterns\Structural\Flyweight\FlyweightFactory;
+
+/**
+ * FlyweightTest demonstrates how a client would use the flyweight structure
+ * You don't have to change the code of your client
+ */
+class FlyweightTest extends \PHPUnit_Framework_TestCase
+{
+	private $characters = array('a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k',
+		'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z');
+	private $fonts = array('Arial', 'Times New Roman', 'Verdana', 'Helvetica');
+
+	// This is about the number of characters in a book of average length
+	private $numberOfCharacters = 300000;
+
+    public function testFlyweight()
+    {
+        $factory = new FlyweightFactory();
+
+        for ($i = 0; $i < $this->numberOfCharacters; $i++) {
+        	$char = $this->characters[array_rand($this->characters)];
+        	$font = $this->fonts[array_rand($this->fonts)];
+        	$flyweight = $factory->$char;
+        	// External state can be passed in like this:
+        	// $flyweight->draw($font);
+        }
+
+        // Flyweight pattern ensures that instances are shared
+        // instead of having hundreds of thousands of individual objects
+        $this->assertLessThanOrEqual($factory->totalNumber(), sizeof($this->characters));
+    }
+}