cs AbstractFactory

Author: Dominik Liebler

AbstractFactory/AbstractFactory.php

@@ -28,6 +28,7 @@ abstract class AbstractFactory
      * Creates a text component
      * 
      * @param string $content
+     *
      * @return Text
      */
     abstract public function createText($content);
@@ -37,6 +38,7 @@ abstract public function createText($content);
      * 
      * @param string $path
      * @param string $name
+     *
      * @return Picture
      */
     abstract public function createPicture($path, $name = '');

AbstractFactory/Html/Picture.php

@@ -11,15 +11,13 @@
  */
 class Picture extends BasePicture
 {
-
     /**
      * some crude rendering from HTML output
      *
      * @return string
      */
     public function render()
     {
-        return sprintf('<img src="%s" title="$s"/>', $this->_path, $this->_name);
+        return sprintf('<img src="%s" title="$s"/>', $this->path, $this->name);
     }
-
 }

AbstractFactory/Html/Text.php

@@ -11,15 +11,13 @@
  */
 class Text extends BaseText
 {
-
     /**
      * some crude rendering from HTML output
      *
      * @return string
      */
     public function render()
     {
-        return '<div>' . htmlspecialchars($this->_text) . '</div>';
+        return '<div>' . htmlspecialchars($this->text) . '</div>';
     }
-
 }

AbstractFactory/HtmlFactory.php

@@ -9,12 +9,12 @@
  */
 class HtmlFactory extends AbstractFactory
 {
-
     /**
      * Creates a picture component
      *
      * @param string $path
      * @param string $name
+     *
      * @return Html\Picture|Picture
      */
     public function createPicture($path, $name = '')
@@ -26,11 +26,11 @@ public function createPicture($path, $name = '')
      * Creates a text component
      *
      * @param string $content
+     *
      * @return Html\Text|Text
      */
     public function createText($content)
     {
         return new Html\Text($content);
     }
-
 }

AbstractFactory/Json/Picture.php

@@ -11,15 +11,13 @@
  */
 class Picture extends BasePicture
 {
-
     /**
      * some crude rendering from JSON output
      *
      * @return string
      */
     public function render()
     {
-        return json_encode(array('title' => $this->_name, 'path' => $this->_path));
+        return json_encode(array('title' => $this->name, 'path' => $this->path));
     }
-
 }

AbstractFactory/Json/Text.php

@@ -11,15 +11,13 @@
  */
 class Text extends BaseText
 {
-
     /**
      * some crude rendering from JSON output
      *
      * @return string
      */
     public function render()
     {
-        return json_encode(array('content' => $this->_text));
+        return json_encode(array('content' => $this->text));
     }
-
 }

AbstractFactory/JsonFactory.php

@@ -16,23 +16,23 @@ class JsonFactory extends AbstractFactory
      *
      * @param string $path
      * @param string $name
+     *
      * @return Json\Picture|Picture
      */
     public function createPicture($path, $name = '')
     {
         return new Json\Picture($path, $name);
     }
 
-
     /**
      * Creates a text component
      *
      * @param string $content
+     *
      * @return Json\Text|Text
      */
     public function createText($content)
     {
         return new Json\Text($content);
     }
-
 }

AbstractFactory/Media.php renamed to AbstractFactory/MediaInterface.php

@@ -3,12 +3,12 @@
 namespace DesignPatterns\AbstractFactory;
 
 /**
- * Interface Media
+ * Interface MediaInterface
  *
  * This contract is not part of the pattern, in general case, each component
  * are not related
  */
-interface Media
+interface MediaInterface
 {
 
     /**

AbstractFactory/Picture.php

@@ -5,7 +5,7 @@
 /**
  * Class Picture
  */
-abstract class Picture implements Media
+abstract class Picture implements MediaInterface
 {
 
     /**

AbstractFactory/Text.php

@@ -5,7 +5,7 @@
 /**
  * Class Text
  */
-abstract class Text implements Media
+abstract class Text implements MediaInterface
 {
     /**
      * @var string

Adapter/ElecBookAdapter.php renamed to Adapter/EBookAdapter.php

@@ -7,20 +7,22 @@
 namespace DesignPatterns\Adapter;
 
 /**
- * ElecBookAdapter is an adapter to fit an e-book like a paper book
+ * EBookAdapter is an adapter to fit an e-book like a paper book
  * 
  * This is the adapter here. Notice it implemennts PaperBookInterface,
  * therefore you don't have to change the code of the client which using paper book.
  */
-class ElecBookAdapter implements PaperBookInterface
+class EBookAdapter implements PaperBookInterface
 {
 
     protected $eBook;
 
     /**
      * Notice the constructor, it "wraps" an electronic book
+     *
+     * @param EBookInterface $ebook
      */
-    public function __construct(ElecBookInterface $ebook)
+    public function __construct(EBookInterface $ebook)
     {
         $this->eBook = $ebook;
     }
@@ -33,9 +35,11 @@ public function open()
         $this->eBook->pressStart();
     }
 
+    /**
+     * turns pages
+     */
     public function turnPage()
     {
         $this->eBook->pressNext();
     }
-
-}
+}

Adapter/EBookInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace DesignPatterns\Adapter;
+
+/**
+ * EBookInterface is a contract for an electronic book
+ */
+interface EBookInterface
+{
+
+    function pressNext();
+
+    function pressStart();
+}

Adapter/ElecBookInterface.php

@@ -25,7 +25,6 @@
  */
 interface Command
 {
-
     /**
      * this is the most important method in the Command pattern,
      * The Receiver goes in the constructor.

Command/Command.php

@@ -1,9 +1,5 @@
 <?php
 
-/*
- * DesignPatternPHP
- */
-
 namespace DesignPatterns\Tests\AbstractFactory;
 
 use DesignPatterns\AbstractFactory\AbstractFactory;
@@ -15,7 +11,6 @@
  */
 class AbstractFactoryTest extends \PHPUnit_Framework_TestCase
 {
-
     public function getFactories()
     {
         return array(
@@ -39,12 +34,11 @@ public function testComponentCreation(AbstractFactory $factory)
             $factory->createText('footnotes')
         );
 
-        $this->assertContainsOnly('DesignPatterns\AbstractFactory\Media', $article);
+        $this->assertContainsOnly('DesignPatterns\AbstractFactory\MediaInterface', $article);
+
         /* this is the time to look at the Builder pattern. This pattern
          * helps you to create complex object like that article above with
          * a given Abstract Factory
          */
-        
     }
-
 }