book

Clean Code in PHP

by Carsten Windler, Alexandre Daubois

October 2022

Beginner to intermediate

264 pages

6h 47m

English

Packt Publishing

Read now

Unlock full access

ContributorsAbout the authorsAbout the reviewers
Who this book is forWhat this book coversTo get the most out of this bookDownload the example code files Download the color images Conventions usedGet in touchShare Your Thoughts
What this book will coverUnderstanding what clean code isThe importance of clean code in teams The importance of clean code in personal projectsSummary
Who decides these things anyway?Best practices – where do they really come from?Design pattern principlesBeing context-awareBeing consistent – get results quickerAbout source code analysis toolsAbout testing and its multiple formsSummary
Understanding codeA bit of historyThe purpose of codeBe understood, not cleverA note on maintainabilityUsing binary operators and octal, hexadecimal, and binary notationsAssigning a variable and using gotosExcessively using commentsUsing ternary comparisonsUsing abbreviations Bringing micro-optimizations to your codeRecoding the methods of the SPL Summary
PHP as an ecosystemChoosing the right librariesA word about semantic versioningWhat is semantic versioning?How to deal with semantic versioningStability versus trendsSummary
Naming and organizational conventionsClass files and interface filesExecutablesWeb assets and resourcesNaming classes, interfaces, and methodsNaming foldersSeparating responsibilitiesEvent dispatchingDemystifying polymorphism – interfaces and abstract classesInterfacesAbstract classesSummary
Old versus new PHPStrict typingError reportingAttributesThe version 8 revolutionMatch syntaxNamed argumentsRead-only classes and propertiesMigrating resources to proper classesProtecting your sensitive arguments from leakingSummary

Technical requirementsSyntax checking and code stylingThe PHP built-in linterPHP CS Fixer: a code snifferStatic Code Analysisphpcpd – the copy and paste detectorPHPMD: the PHP mess detectorPHPStan – a static analyzer for PHPPsalm: A PHP static analysis linting machineIDE extensionsPHP Inspections (EA Extended)IntelephenseSummaryFurther reading
Technical requirementsIntroducing code quality metricsAspects of software quality Code quality metricsGathering metrics in PHPphplocPHP DependPhpMetricsThe pros and cons of using metricsThe prosThe consSummaryFurther reading
Technical requirementsInstalling code quality tools using ComposerInstalling code quality tools using require-devGlobal installationComposer scriptsInstalling code quality tools as phar filesKeeping your phar files organizedManaging phar files using PhiveAdding Phive to your projectSummary
Technical requirementsWhy you need automated testsEasier refactoring with testsTypes of automated testsUnit testsIntegration testsE2E testsThe testing pyramid in practiceAbout code coverageUnderstanding code coverageHow to generate code coverage reportsUsing the @covers annotation What to testSummaryFurther reading
Technical requirementsWhy you need CIThe costs of a bugHow to prevent bugsIntroducing CIThe build pipelineStage 1: Build projectStage 2 – Code analysisStage 3 – TestsStage 4 – DeployIntegrating the pipeline into your workflowBuilding a pipeline with GitHub ActionsGitHub Actions in a nutshellStage 1 – Build projectStage 2 – Code analysisStage 3 – TestsStage 4 – DeployIntegrating the pipeline into your workflowYour local pipeline – Git hooksSetting up Git hooksGit hooks in practiceAdvanced usageExcursion – Adding CI to existing softwareStep by stepAn outlook on CDSummaryFurther reading
Technical requirementsCoding standardsGoing with existing standardsCoding guidelinesExamples of coding guidelinesSetting up guidelinesCode reviewsWhy you should do code reviewsWhat code reviews should coverBest practices for code reviewsEnsuring code reviews are doneDefinition of doneCode reviews conclusionDesign patternsUnderstanding design patternsCommon design patterns in PHPAnti-patternsSummaryFurther reading
Technical requirementsWhy documentation mattersWhy documentation is importantDeveloper documentationCreating documentationText documentsDiagramsDocumentation generatorsInline documentationAnnotations are no codeUnreadable codeOutdated commentsUseless commentsWrong or useless DocBlocksTODO commentsWhen commenting is usefulTests as documentationSummaryFurther reading
Other Books You May EnjoyPackt is searching for authors like you

Content preview from Clean Code in PHP

8 Code Quality Metrics

Wouldn’t it be great if we could measure the quality of our software? Software developers often want to improve their software again and again – but maybe it is already “good enough.” How do we know when it reaches a good state?

Software quality metrics were introduced by smart people in the early days of programming. In the 1970s, they thought about this topic and produced the ideas that are still in use today. Of course, we want to benefit from this knowledge and apply it to our own projects.

In this chapter, we are going to cover the following topics: