El-kady / DesignPatternsPHP

sample code for several design patterns in PHP

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:

[option] Using Docker

You can optionally run tests using Docker for Mac or Windows or native one for Linux. Just run:

docker-compose up

[optional] [DEPRECATED] Using a Virtual Machine (VM)

If you wish to use a ready made VM environment, you can easily create one with Vagrant and Ansible.

$ vagrant up

Then vagrant ssh and cd /vagrant

More information on vagrant

Install dependencies

$ composer install

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

Running test suite

$ ./vendor/bin/phpunit

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

• Adapter 📓
• Bridge 📓
• Composite 📓
• DataMapper 📓
• Decorator 📓
• DependencyInjection 📓
• Facade 📓
• FluentInterface 📓
• Flyweight 📓
• Proxy 📓
• Registry 📓

Behavioral

• ChainOfResponsibilities 📓
• Command 📓
• Iterator 📓
• Mediator 📓
• Memento 📓
• NullObject 📓
• Observer 📓
• Specification 📓
• State 📓
• Strategy 📓
• TemplateMethod 📓
• Visitor 📓

More

• Delegation 📓
• 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 ..

License

(The MIT License)

Copyright (c) 2011 - 2017 Dominik Liebler and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.