DesignPatternsPHP

Read the Docs of DesignPatternsPHP or Download as PDF/Epub

This is a collection of known design patterns and some sample code how to implement them in PHP. Every pattern has a small list of examples (most of them from Zend Framework, Symfony2 or Doctrine2 as I'm most familiar with this software).

I think the problem with patterns is that often people do know them but don't know when to apply which.

Installation

You should look at and run the tests to see what happens in the example. To do this, you should install dependencies with Composer first:

$ composer install

Read more about how to install and use Composer on your local machine here.

To run the tests use phpunit:

$ ./vendor/bin/phpunit

using Docker (optional)

You can optionally build and browse the documentation using Docker for Mac, Windows or Linux.

Just run:

$ docker-compose up

Go to http://localhost:8080/README.html to read the generated documentation.

To only install the dependencies, use docker-compose like this:

$ docker-compose run php php composer.phar install

Patterns

The patterns can be structured in roughly three different categories. Please click on the 📓 for a full explanation of the pattern on Wikipedia.

Creational

AbstractFactory 📓
Builder 📓
FactoryMethod 📓
Multiton (is considered an anti-pattern! ⛔)
Pool 📓
Prototype 📓
SimpleFactory
Singleton 📓 (is considered an anti-pattern! ⛔)
StaticFactory

Structural

Behavioral

ServiceLocator 📓 (is considered an anti-pattern! ⛔)
Repository
EAV 📓

Contribute

If you encounter any bugs or missing translations, please feel free to fork and send a pull request with your changes. To establish a consistent code quality, please check your code using PHP_CodeSniffer against PSR2 standard using ./vendor/bin/phpcs -p --standard=PSR2 --ignore=vendor ..

lvshuang / designpatternsphp Goto Github PK