Mastering PSR Standards and Coding Style in PHP

3.8 PSR Standards and Coding Style

In the world of PHP development, maintaining a consistent coding style is crucial for creating readable, maintainable, and scalable code. The PHP Standards Recommendations (PSRs) provide a set of guidelines that help developers achieve this consistency. In this section, we will delve into the significance of PSR standards, particularly focusing on PSR-12, and explore how adhering to these standards can enhance your PHP projects.

Introduction to PHP Standards Recommendations (PSRs)

The PHP Standards Recommendations (PSRs) are a collection of guidelines and best practices established by the PHP Framework Interoperability Group (PHP-FIG). These standards aim to promote consistency and interoperability across PHP projects, making it easier for developers to collaborate and integrate different libraries and frameworks.

Key PSRs to Know

• PSR-1: Basic Coding Standard - Establishes a basic level of coding style, including file structure and naming conventions.
• PSR-2: Coding Style Guide - Provides a comprehensive coding style guide, which has been superseded by PSR-12.
• PSR-4: Autoloading Standard - Defines a standard for autoloading classes using file paths.
• PSR-12: Extended Coding Style Guide - An extension of PSR-2, offering more detailed guidelines for modern PHP code.

For a complete list of PSRs, visit the PHP-FIG - PHP Standards Recommendations.

Implementing PSR-12 Coding Style in Projects

PSR-12 is the latest coding style guide that builds upon PSR-2, providing a more comprehensive set of rules for modern PHP development. Let’s explore how to implement PSR-12 in your projects.

Key Aspects of PSR-12

1. File Structure and Naming Conventions

   • Files MUST use only <?php and <?= tags.
   • Files MUST use only UTF-8 without BOM for PHP code.
   • Class names MUST be declared in StudlyCaps.
   • Class constants MUST be declared in all upper case with underscore separators.

2. Indentation and Line Length

   • Code MUST use 4 spaces for indenting, not tabs.
   • Lines SHOULD not be longer than 80 characters; lines MUST not be longer than 120 characters.

3. Namespace and Use Declarations

   • There MUST be one blank line after the namespace declaration.
   • There MUST be one blank line after the use block.

4. Class and Method Declarations

   • Visibility MUST be declared on all properties and methods.
   • The abstract and final declarations MUST precede the visibility declaration.

5. Control Structures

   • Control structure keywords MUST have one space after them.
   • Opening braces for control structures MUST go on the same line, and closing braces MUST go on the next line after the body.

6. Function Calls and Definitions

   • In the argument list, there MUST NOT be a space before each comma, and there MUST be one space after each comma.
   • Method and function arguments with default values MUST go at the end of the argument list.

Example of PSR-12 Compliant Code

 1<?php
 2
 3namespace App\Controller;
 4
 5use App\Service\UserService;
 6
 7class UserController
 8{
 9    private UserService $userService;
10
11    public function __construct(UserService $userService)
12    {
13        $this->userService = $userService;
14    }
15
16    public function getUser(int $id): ?User
17    {
18        if ($id <= 0) {
19            throw new InvalidArgumentException('Invalid user ID');
20        }
21
22        return $this->userService->findUserById($id);
23    }
24}

Benefits of Adhering to Coding Standards

Adhering to coding standards like PSR-12 offers numerous benefits:

• Consistency: Ensures a uniform coding style across the codebase, making it easier for developers to read and understand the code.
• Collaboration: Facilitates collaboration among team members by reducing misunderstandings and discrepancies in coding styles.
• Maintainability: Improves the maintainability of the code by making it easier to identify and fix bugs.
• Interoperability: Enhances interoperability between different libraries and frameworks, as they follow the same standards.
• Professionalism: Demonstrates a commitment to quality and professionalism in software development.

Tools for Enforcing PSR Standards

To ensure compliance with PSR standards, developers can use various tools:

• PHP_CodeSniffer: A popular tool for detecting violations of coding standards in PHP code.
• PHP-CS-Fixer: Automatically fixes coding style issues according to PSR standards.
• PHPStan: A static analysis tool that helps find bugs in your code.

Visualizing PSR-12 Compliance

To better understand how PSR-12 compliance affects your code, let’s visualize the structure of a PSR-12 compliant PHP file using a class diagram.

    classDiagram
	    class UserController {
	        -UserService userService
	        +__construct(UserService userService)
	        +getUser(int id) User
	    }
	    class UserService {
	        +findUserById(int id) User
	    }
	    UserController --> UserService

Try It Yourself

To get hands-on experience with PSR-12, try modifying the following code snippet to make it PSR-12 compliant:

 1<?php
 2
 3namespace App\Controller;
 4use App\Service\UserService;
 5
 6class usercontroller {
 7    private $userService;
 8
 9    public function __construct(UserService $userService) {
10        $this->userService=$userService;
11    }
12
13    public function getuser($id) {
14        if ($id <= 0) {
15            throw new \InvalidArgumentException('Invalid user ID');
16        }
17        return $this->userService->findUserById($id);
18    }
19}

Knowledge Check

• What are the key differences between PSR-2 and PSR-12?
• How does adhering to PSR standards improve code maintainability?
• What tools can you use to enforce PSR compliance in your projects?

Embrace the Journey

Remember, mastering PSR standards and coding style is a journey. As you continue to apply these principles, you’ll find that your code becomes more readable, maintainable, and professional. Keep experimenting, stay curious, and enjoy the process of becoming a better PHP developer!

Quiz: PSR Standards and Coding Style