Welcome to the Clean PHP Documentation Repository, where we strive to provide comprehensive and up-to-date information on writing clean, maintainable, and scalable PHP code. Here, you will find information on SOLID patterns and Clean Code principles, as well as examples of good practices in PHP.
Our goal is to provide you with the tools and knowledge you need to write code that is easy to understand, modify, and test, so that you can build high-quality software that is reliable, efficient, and scalable.
SOLID is a set of five design principles for writing maintainable and scalable software. These principles promote code that is easy to understand, modify, and test, and help to prevent code from becoming complex and difficult to maintain.
Clean Code, on the other hand, is a set of guidelines for writing code that is easy to read, understand, and modify. Clean Code encourages the use of simple, clear, and concise code that follows established conventions and principles, and helps to avoid code that is confusing, inconsistent, or difficult to maintain.
In this repository, we will provide examples of good practices in PHP based on SOLID, Clean Code principles and some other resources that imply writing a better code in a daily basis. These examples will include information on naming conventions, functions, objects and data structures, comments, and formatting.
By following these examples, you can write clean and maintainable PHP code that is easy to understand and modify.
This project is written and maintained by Santiago Strella. You can contact the author through Slack or email at:
Feel free to leave feedback, report errors or just come to tell how cool this project is.
Moreover, this document provides insights on how to report an issue.
- "Clean Code: A Handbook of Agile Software Craftsmanship" by Robert "Uncle Bob" Martin
- https://www.youtube.com/playlist?list=PLfgj7DYkKH3Cd8bdu5SIHGYXh_bPV2idP
- https://levelup.gitconnected.com/solid-principles-simplified-php-examples-based-dc6b4f8861f6
- https://www.freecodecamp.org/news/solid-principles-explained-in-plain-english/
- https://latteandcode.medium.com/php-y-principios-solid-86c77d56e90
- https://gist.github.com/wojteklu/73c6914cc446146b8b533c0988cf8d29
- https://dzone.com/articles/clean-code-summary-and-key-points
- https://github.com/piotrplenik/clean-code-php
- https://dev.to/evrtrabajo/solid-in-php-d8e