DesignPatternsPHP/README.rst

54 lines
1.8 KiB
ReStructuredText
Raw Normal View History

2015-04-02 00:06:29 +02:00
.. DesignPatternsPHP
2015-04-05 03:29:00 +02:00
=================
2015-04-02 00:03:33 +02:00
DesignPatternsPHP
=================
2018-06-14 23:02:18 +02:00
.. image:: https://travis-ci.org/domnikl/DesignPatternsPHP.svg?branch=master
:target: https://travis-ci.org/domnikl/DesignPatternsPHP
:alt: Build Status
2015-04-05 03:29:00 +02:00
.. image:: https://readthedocs.org/projects/designpatternsphp/badge/?version=latest
:target: https://readthedocs.org/projects/designpatternsphp/?badge=latest
2015-04-02 00:33:44 +02:00
:alt: Documentation Status
2015-04-02 00:03:33 +02:00
2017-12-27 08:07:51 +01:00
.. image:: https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square
2017-12-27 08:26:12 +01:00
:target: https://paypal.me/DominikLiebler
2017-12-27 08:07:51 +01:00
:alt: Donate
2015-04-05 03:29:00 +02:00
This is a collection of known `design patterns`_ and some sample code how
2015-04-02 00:03:33 +02:00
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.
Patterns
--------
The patterns can be structured in roughly three different categories.
2015-04-05 03:29:00 +02:00
Please click on **the title of every pattern's page** for a full explanation of the pattern on Wikipedia.
2015-04-02 00:03:33 +02:00
2015-04-02 00:16:16 +02:00
.. toctree::
:titlesonly:
:numbered:
Creational/README
Structural/README
Behavioral/README
More/README
2015-04-02 00:03:33 +02:00
Contribute
----------
2016-09-23 10:55:22 +02:00
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
2015-04-07 22:00:12 +02:00
`PHP CodeSniffer`_ against `PSR2 standard`_
2015-04-02 00:03:33 +02:00
using ``./vendor/bin/phpcs -p --standard=PSR2 --ignore=vendor .``.
2018-05-04 23:05:24 +03:00
.. _`design patterns`: http://en.wikipedia.org/wiki/Software_design_pattern
.. _`PHP CodeSniffer`: https://github.com/squizlabs/PHP_CodeSniffer
.. _`PSR2 standard`: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md