...by estevaojneto (Estevão Neto)
These are practical examples implementations of the most popular PHP Design Patterns. The idea is that there is a sample data file containing information about 3 animals: cats, rats and bats, and we operate upon this data using Design Patterns. Each Design Pattern is separate into its own folder, and each folder contains:
- A README file containing a brief theoretical explanation of the Pattern;
- A
run.phpfile which executes the code example - you can execute it with the commandphp run.php; - PHP code files which are required to show the example.
If you check data.json, it has a list of each animal and its attributes. You can think of this, for example, as the return info for an API, and each example as a possible use-case for consuming that API using PHP.
Because they sound like similar names for animals which are different between them. Despite that, they are animals which might overlap between them in some characteristics:
-
Rats and Bats are (kind-of) rodents*, but Cats are felines;
-
Cats and Rats can only walk and run, but Bats can fly;
-
Bats and Cats are carnivores, but Rats are herbivore.
I do know these are very simplified and crass views of each animal, but they are good for illustrating the Patterns I want to show.
*Bats are actually not rodents and are actually closer to primates, but it is a common mistake so we'll use that for the example.
Run php run.php inside each example folder. Please note the examples here were created using PHP8.0.
I have set the constraint of using only the Pattern I would like to demonstrate in each example. This is so the code base for each example wouldn't exponentially grow; for example, in the Iterator example, I could have used Factories for each Iterator; the simple example would then expand to something much bigger. So I have set a goal to show only one Pattern per example. In situations where more than one pattern could be used, I will mention it in the respective documentation of the Pattern.
These Patterns will be continually added and reviewed, it might be that the ones you want aren't here yet. I apologise for so - if there is any Pattern not here that you would like me to do an example, by all please let me know! You can find my LinkedIn page in my Github profile.
There is currently a huge discussion going around in the programmers' world about certain programmers who get fixated in memorizing OOP concepts and patterns. My view is that Design Patterns should be used to solve or avoid programming problems. So this repo can be used as a reference for PHP developers, or even people who work with OOP in general; however we must never forget that patterns aren't just meant to look pretty or show-off to others how much you memorized them. Remember that context matters and that the programmer is not alone in the development of any technology product.