Book Image

Clean Code in PHP

By : Carsten Windler, Alexandre Daubois
5 (1)
Book Image

Clean Code in PHP

5 (1)
By: Carsten Windler, Alexandre Daubois

Overview of this book

PHP is a beginner-friendly language, but also one that is rife with complaints of bad code,;yet no clean code books are specific to PHP. Enter Clean Code in PHP. This book is a one-stop guide to learning the theory and best practices of clean code specific to real-world PHP app development environments. This PHP book is cleanly split to help you navigate through coding practices and theories to understand and adopt the nuances of the clean code paradigm. In addition to covering best practices, tooling for code quality, and PHP design patterns, this book also presents tips and techniques for working on large-scale PHP apps with a team and writing effective documentation for your PHP projects. By the end of this book, you’ll be able to write human-friendly PHP code, which will fuel your PHP career growth and set you apart from the competition.

Related Content you might be interested in

Current Title:

Small book image
Clean Code in PHP
Carsten Windler | Alexandre Daubois
Oct, 2022 | 264 pages
Small book image
The Art of Modern PHP 8
Joseph Edmonds
Oct, 2021 | 420 pages
Small book image
Test-Driven Development with PHP 8
Rainier Sarabia
Jan, 2023 | 336 pages
Small book image
PHP Web Development with Laminas
Flávio Gomes da Silva Lisboa
Nov, 2022 | 394 pages
Table of Contents (18 chapters)
Preface
Preface
Who this book is for
What this book covers
To get the most out of this book
Download the example code files
Download the color images
Conventions used
Get in touch
Share Your Thoughts
1
Part 1 – Introducing Clean Code
Part 1 – Introducing Clean Code
Free Chapter
2
Chapter 1: What Is Clean Code and Why Should You Care?
Chapter 1: What Is Clean Code and Why Should You Care?
What this book will cover
Understanding what clean code is
The importance of clean code in teams
The importance of clean code in personal projects
Summary
3
Chapter 2: Who Gets to Decide What “Good Practices” Are?
Chapter 2: Who Gets to Decide What “Good Practices” Are?
Who decides these things anyway?
Best practices – where do they really come from?
Being context-aware
Being consistent – get results quicker
Summary
4
Chapter 3: Code, Don’t Do Stunts
Chapter 3: Code, Don’t Do Stunts
Understanding code
Be understood, not clever
A note on maintainability
Summary
5
Chapter 4: It is about More Than Just Code
Chapter 4: It is about More Than Just Code
PHP as an ecosystem
Choosing the right libraries
A word about semantic versioning
Stability versus trends
Summary
6
Chapter 5: Optimizing Your Time and Separating Responsibilities
Chapter 5: Optimizing Your Time and Separating Responsibilities
Naming and organizational conventions
Separating responsibilities
Demystifying polymorphism – interfaces and abstract classes
Summary
7
Chapter 6: PHP is Evolving – Deprecations and Revolutions
Chapter 6: PHP is Evolving – Deprecations and Revolutions
Old versus new PHP
The version 8 revolution
Summary
8
Part 2 – Maintaining Code Quality
Part 2 – Maintaining Code Quality
9
Chapter 7: Code Quality Tools
Chapter 7: Code Quality Tools
Technical requirements
Syntax checking and code styling
Static Code Analysis
IDE extensions
Summary
Further reading
10
Chapter 8: Code Quality Metrics
Chapter 8: Code Quality Metrics
Technical requirements
Introducing code quality metrics
Gathering metrics in PHP
The pros and cons of using metrics
Summary
Further reading
11
Chapter 9: Organizing PHP Quality Tools
Chapter 9: Organizing PHP Quality Tools
Technical requirements
Installing code quality tools using Composer
Installing code quality tools as phar files
Managing phar files using Phive
Summary
12
Chapter 10: Automated Testing
Chapter 10: Automated Testing
Technical requirements
Why you need automated tests
Types of automated tests
About code coverage
Summary
Further reading
13
Chapter 11: Continuous Integration
Chapter 11: Continuous Integration
Technical requirements
Why you need CI
The build pipeline
Building a pipeline with GitHub Actions
Your local pipeline – Git hooks
Excursion – Adding CI to existing software
An outlook on CD
Summary
Further reading
14
Chapter 12: Working in a Team
Chapter 12: Working in a Team
Technical requirements
Coding standards
Coding guidelines
Code reviews
Design patterns
Summary
Further reading
15
Chapter 13: Creating Effective Documentation
Chapter 13: Creating Effective Documentation
Technical requirements
Why documentation matters
Creating documentation
Inline documentation
Summary
Further reading
16
Index
Index
Why subscribe?
17
Other Books You May Enjoy
Other Books You May Enjoy
Packt is searching for authors like you

Gathering metrics in PHP

In this section, we want to have a look at the tools there are in the PHP world to gather code quality metrics. As you will see shortly, these metrics are not just numbers – they will allow you to make educated guesses about how much effort it will take to refactor code. They will also help you to identify the parts of the code that will require the most attention.

Again, we have curated a selection of tools for you:

  • phploc
  • PHP Depend
  • PhpMetrics

phploc

As we learned in the previous section, the abbreviation LOC stands for lines of code, so the name already reveals the main purpose of this tool. Being a basic metric, it already tells us quite a few things about a code base. phploc also provides further metrics, such as the CC, so it is worth having a closer look at it.

Installation and usage

The author of this tool, Sebastian Bergmann, is well known for phpunit, the de facto standard for automated tests in the PHP world...

Previous Section
End of Section 4
Next Section