. PHP Design Patterns . PHP Design Patterns Abstract Factory

PHP Design Patterns Abstract Factory

About the Abstract Factory

In the Abstract Factory Pattern, an abstract factory defines what objects the non-abstract or concrete factory will need to be able to create.

The concrete factory must create the correct objects for it's context, insuring that all objects created by the concrete factory have been chosen to be able to work correctly for a given circumstance.

In this example we have an abstract factory, AbstractBookFactory, that specifies two classes, AbstractPHPBook and AbstractMySQLBook, which will need to be created by the concrete factory.

The concrete class OReillyBookfactory extends AbstractBookFactory, and can create the OReillyMySQLBook and OReillyPHPBook classes, which are the correct classes for the context of OReilly.

AbstractBookFactory.php


//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved

  abstract class AbstractBookFactory {
  
    abstract function makePHPBook();
    
    abstract function makeMySQLBook();
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

OReillyBookFactory.php


//copyright Lawrence Truett and FluffyCat.com 2005, all rights reserved

  include_once('AbstractBookFactory.php');
  
  include_once('OReillyPHPBook.php');
  include_once('OReillyMySQLBook.php');
  
  class OReillyBookFactory extends AbstractBookFactory {
  
    private $context = "OReilly";  
  
    function makePHPBook() {return new OReillyPHPBook;}
    
    function makeMySQLBook() {return new OReillyMySQLBook;}
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

SamsBookFactory.php


//copyright Lawrence Truett and FluffyCat.com 2005, all rights reserved

  include_once('AbstractBookFactory.php');
  
  include_once('SamsPHPBook.php');
  include_once('SamsMySQLBook.php');
  
  class SamsBookFactory extends AbstractBookFactory {
  
    private $context = "Sams";   
  
    function makePHPBook() {return new SamsPHPBook;}
    
    function makeMySQLBook() {return new SamsMySQLBook;}
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

AbstractBook.php

  
//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved
  
    abstract class AbstractBook {
  
    abstract function getAuthor();
    
    abstract function getTitle();
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

AbstractMySQLBook.php

//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved
  
    include_once('AbstractBook.php');
  
    abstract class AbstractMySQLBook {
  
    private $subject = "MySQL";
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

OReillyMySQLBook.php

//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved

  include_once('AbstractMySQLBook.php');
  
  class OReillyMySQLBook extends AbstractMySQLBook {
  
    private $author;
    
    private $title;
    
    function __construct() {
    
      $this->author = 'George Reese, Randy Jay Yarger, and Tim King';
      $this->title  = 'Managing and Using MySQL';
 
    }
  
    function getAuthor() {return $this->author;}
    
    function getTitle() {return $this->title;}
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

SamsMySQLBook.php

//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved

  include_once('AbstractMySQLBook.php');
  
  class SamsMySQLBook extends AbstractMySQLBook {
  
    private $author;
    
    private $title;
    
    function __construct() {
    
      $this->author = 'Paul Dubois';
      $this->title  = 'MySQL, 3rd Edition';
 
    }
  
    function getAuthor() {return $this->author;}
    
    function getTitle() {return $this->title;}
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

AbstractPHPBook.php

//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved
  
    include_once('AbstractBook.php');
  
    abstract class AbstractPHPBook {
  
    private $subject = "PHP";
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

OReillyPHPBook.php

//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved

  include_once('AbstractPHPBook.php');
  
  class OReillyPHPBook extends AbstractPHPBook {
  
    private $author;
    
    private $title;
    
    private static $oddOrEven = 'odd';
    
    function __construct() {
    
    
    
      //alternate between 2 books
      
      if ('odd' == self::$oddOrEven) {
        $this->author = 'Rasmus Lerdorf and Kevin Tatroe';
        $this->title  = 'Programming PHP';
        self::$oddOrEven = 'even';
      } else {
        $this->author = 'David Sklar and Adam Trachtenberg';
        $this->title  = 'PHP Cookbook'; 
        self::$oddOrEven = 'odd';
      }  
    }
  
    function getAuthor() {return $this->author;}
    
    function getTitle() {return $this->title;}
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

SamsPHPBook.php

//copyright Lawrence Truett and FluffyCat.com 2007, all rights reserved

  include_once('AbstractPHPBook.php');
  
  class SamsPHPBook extends AbstractPHPBook {
  
    private $author;
    
    private $title;
    
    function __construct() {
    
      //alternate randomly between 2 books
      
      mt_srand((double)microtime()*10000000);
      $rand_num = mt_rand(0,1);      
      
      if (1 > $rand_num) {
        $this->author = 'George Schlossnagle';
        $this->title  = 'Advanced PHP Programming';
      } else {
        $this->author = 'Christian Wenz';
        $this->title  = 'PHP Phrasebook'; 
      }  
    }
  
    function getAuthor() {return $this->author;}
    
    function getTitle() {return $this->title;}
  
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

testAbstractFactory.php


//copyright Lawrence Truett and FluffyCat.com 2005, all rights reserved

  include_once('OReillyBookFactory.php');  
  include_once('SamsBookFactory.php');

  echo tagins("html");
  echo tagins("head");  
  echo tagins("/head");  
  echo tagins("body");

  echo "BEGIN TESTING ABSTRACT FACTORY PATTERN";
  echo tagins("br").tagins("br");
  
  echo 'testing OReillyBookFactory'.tagins("br");
  $bookFactoryInstance = new OReillyBookFactory;
  testConcreteFactory($bookFactoryInstance);
  
  echo tagins("br");
  
  echo 'testing SamsBookFactory'.tagins("br");
  $bookFactoryInstance = new SamsBookFactory;
  testConcreteFactory($bookFactoryInstance);  
  
  echo tagins("br");
  echo "END TESTING ABSTRACT FACTORY PATTERN";
  echo tagins("br");
  
  echo tagins("/body");
  echo tagins("/html");

  function testConcreteFactory($bookFactoryInstance) {
    $phpBookOne = $bookFactoryInstance->makePHPBook();
    echo 'first php Author: '. 
	  $phpBookOne->getAuthor().tagins("br");
    echo 'first php Title: '.
	  $phpBookOne->getTitle().tagins("br");
	  
    $phpBookTwo = $bookFactoryInstance->makePHPBook();
    echo 'second php Author: '.
	  $phpBookTwo->getAuthor().tagins("br");
    echo 'second php Title: '.
	  $phpBookTwo->getTitle().tagins("br");
    
	$mySqlBook = $bookFactoryInstance->makeMySQLBook();
    echo 'MySQL Author: '.
	  $mySqlBook->getAuthor().tagins("br");
    echo 'MySQL Title: '.
	  $mySqlBook->getTitle().tagins("br");
  }
  
  //doing this so code can be displayed without breaks
  function tagins($stuffing) {
    return "<".$stuffing.">";
  }

download source, use right-click and "Save Target As..." to save with a .php extension.

output of testAbstractFactory.php

BEGIN TESTING ABSTRACT FACTORY PATTERN


testing OReillyBookFactory
first php Author: Rasmus Lerdorf and Kevin Tatroe
first php Title: Programming PHP
second php Author: David Sklar and Adam Trachtenberg
second php Title: PHP Cookbook
MySQL Author: George Reese, Randy Jay Yarger, and Tim King
MySQL Title: Managing and Using MySQL


testing SamsBookFactory
first php Author: Christian Wenz
first php Title: PHP Phrasebook
second php Author: George Schlossnagle
second php Title: Advanced PHP Programming
MySQL Author: Paul Dubois
MySQL Title: MySQL, 3rd Edition


END TESTING ABSTRACT FACTORY PATTERN

References

Design Patterns

Design Patterns by Erich Gamma, Richard Helm, Ralph Johnson, and John Vlissides

PHP 5

The Official PHP web site
Core PHP Programming, 3rd Edition by Leon Atkinson and Zeev Suraski

Comments Comments are left by visitors to FluffyCat.com, are not endorsed by FluffyCat.com, and may or may not be accurate.

Comment by milh_cbt Rate this Comment

hi,
I'm new to PHP, but experienced with java. I this path of code mistaken.
you wrote
abstract class AbstractMySQLBook {
it should be
class OReillyMySQLBook extends AbstractMySQLBook {
so the phpbook one.

Comment by Leonardo Rate this Comment

Hi!

In the Design Patterns Abstract Factory, the Class AbstractMySQLBook should be to inherit from AbstractBook.
Same for AbstractPHPBook.

The code run well because AbstractBook only define protocol, and the concrete class implement it.

Bye and thank Yuo very much for the examples!

Leoanrdo

Comment by ngungo Rate this Comment

Hi there,

This is an off topic comment. The home page is quite reasonable but when you go into each topic, it is so sloooow that to the point you want to quit.

I am a developer (see http://monpage.com) who would like to learn more about OOP. Thanks for website and hope that it would be a little more snappy next time I visit. :)

ngungo

Comment by ngungo Rate this Comment

Hi there,

This is an off topic comment. The home page is quite reasonable but when you go into each topic, it is so sloooow that to the point you want to quit.

I am a developer (see http://monpage.com) who would like to learn more about OOP. Thanks for website and hope that it would be a little more snappy next time I visit. :)

ngungo

to add your own comment