DesignPatternsPHP README

The project's README from github.com/DesignPatternsPHP/DesignPatternsPHP. As one markdown file: README.md.

DesignPatternsPHP

Build Status Documentation Status

Read the Docs of DesignPatternsPHP or Download as PDF/Epub

This is a collection of known design patterns and some sample codes on how to implement them in PHP. Every pattern has a small list of examples.

I think the problem with patterns is that often people do know them but don't know when to apply which. Remember that each pattern has its own trade-offs. And you need to pay attention more to why you're choosing a certain pattern than to how to implement it.

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 --build

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

If you want to localize your documentation you can pass the locale as an argument to the docker build:

$ docker-compose build --build-arg language=de
$ docker-compose up

Patterns

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

Creational

Structural

Behavioral

More

Localization & Supported Languages

The following languages are currently available. However not all are actively supported. The current policy is: if there are no native-speaking maintainers we cannot support the given language. We will still leave the translation as is but we will not update it as the base (English) changes. The table below list which language version is considered "supported" and who maintains it.

We're sorry. We would love to maintain them but it is not possible for us. So if you would like to take care of one or more languages - contact us.

Code Language Documentation Actively Supported? Maintainer
en English Docs :notebook: YES --
de German Docs :notebook: NO -
ca Catalan Docs :notebook: NO -
zh_CN Chinese Docs :notebook: NO -
nl Dutch Docs :notebook: NO -
bg Bulgarian Docs :notebook: YES --
ja Japanese Docs :notebook: NO -
pl Polish Docs :notebook: NO -
pt_BR Portuguese-Brazil Docs :notebook: NO -
ru Russian Docs :notebook: NO -
es Spanish Docs :notebook: NO -
es_MX Spanish-Mexican Docs :notebook: NO -
tr Turkish Docs :notebook: NO -
fr French Docs :notebook: NO -
it Italian Docs :notebook: NO -
uk Ukrainian Docs :notebook: NO -

DesignPatternsPHP (DesignPatternsPHP/DesignPatternsPHP)

Searching Database…

22.2K ·GitHub
DesignPatternsPHP
Что это такое?Подборка известных паттернов проектирования с небольшими примерами реализации на PHP 8.x. Она учит не только тому, как устроен каждый паттерн, но и когда его стоит применять.
Это библиотека, которую я подключу к своему проекту, или примеры кода для изучения?Это не библиотека для установки — это набор отдельных проектов-примеров: для каждого паттерна есть свой небольшой список примеров, которые вы читаете и запускаете в процессе обучения.
Как запустить примеры?Склонируйте репозиторий, выполните composer install, затем запустите тесты командой phpunit — так вы увидите каждый пример в действии.
Нужна ли определённая версия PHP для запуска?Код написан под PHP 8.x, поэтому вам понадобится среда PHP 8 и Composer для управления зависимостями.
Можно ли читать документацию офлайн?Да — документация опубликована онлайн на Read the Docs, и её целиком можно также скачать в формате PDF или Epub.
Какие паттерны не входят в три классические категории?Раздел «More» добавляет Repository, EAV (Entity-Attribute-Value) и Service Locator к группам порождающих, структурных и поведенческих паттернов.
Куда ведут ссылки на тетрадь рядом с каждым паттерном?Каждый паттерн ссылается на его подробное описание в Википедии, чтобы вы могли сначала прочитать теорию, а уже потом перейти к примерам на PHP.
What are similar projects?design-patterns-for-humans, go-patterns, python-mastery, grokking_algorithms, GolangTraining, software-architecture-books, python-patterns, learngo
Which topics is it in?software-design, oop, patterns, epub, coding, design-patterns, examples, php, computer-science, pdf, reference, beginner-friendly
Creator
DesignPatternsPHP
Size
6.1 MB
Stars
22.2K
Updated
CommitFeb 03
Age
15y
Commits · 90 Days