search
HomeBackend DevelopmentPHP Tutorial[PHP] PSR brief specification

PSR is a series of specifications about PHP development. There are several versions. I learned it superficially, but I still hope to check the specifications from time to time. In order to facilitate memory and follow, I picked out the necessary keywords and made a Simply necessary normative records. (Just a brick mover...)
https://github.com/PizzaLiu/PHP-FIG
http://segmentfault.com/a/1190000002521577

Official release file version

PSR-0(deprecated)

PSR-1 Basic Code Specification

PSR-2 Code Style Specification

PSR-2 Supplementary Documentation

PSR-3 log interface specification

PSR-4 automatically loaded

PSR-5 and PSR-6 voting has not passed yet

must PSR-1 Basic Code Specification

php code file must start with

PHP code files must be encoded in UTF-8 without BOM;

Namespaces and classes must comply with PSR’s autoloading specification: one of PSR-0 or PSR-4;

The naming of classes must follow the StudlyCaps camel case naming convention starting with an uppercase letter;

All letters of constants in the class must be capitalized, and words are separated by underscores;

Method names must comply with camelCase-style camelCase naming convention starting with lowercase.

PHP code must use long tag or = ?> short output tag; other custom tags must not be used.

Namespace and class naming must comply with PSR-0.

Code for PHP 5.3 and later versions must use formal namespaces.

Each class is an independent file, and the namespace has at least one level: the top-level organization name (vendor name)

PSR-2 coding style guide

Code must follow the coding specifications in PSR-1.

Code must be indented using 4 spaces instead of the tab key.

Note: The advantage of using spaces instead of tab keys for indentation is to avoid confusion when comparing code differences, patching, reviewing code, and comments. Also, use spaces for indentation to make alignment easier.

A blank line must be inserted after each namespace declaration statement and use declaration block.

The opening curly brace ({) of the class must be written on its own line after the function declaration, and the closing curly brace (}) must also be written on its own line after the function body.

The opening curly brace ({) of the method must be written on its own line after the function declaration, and the closing curly brace (}) must also be written on its own line after the function body.

The properties and methods of the class must add access modifiers (private, protected and public), abstract and final must be declared before the access modifier, and static must be declared after the access modifier.

There must be a space after the keyword of the control structure, but it must not be when calling a method or function.

The opening brace ({) of the control structure must be written on the same line as the declaration, and the closing brace (}) must be written on its own line after the body.

There must be no spaces after the opening left bracket and before the closing right bracket of the control structure.

All PHP files must use Unix LF (linefeed) as the line terminator.

All PHP files must end with a blank line.

Pure PHP code files must omit the final ?> closing tag.

There must not be more than one statement per line.

There must be no extra spaces after non-blank lines.

All PHP keywords must be in lowercase.

The constants true, false and null must also be all lowercase.

PSR-3 log interface specification PSR-4 automatic loading specification

A complete class name must have the following structure:

  1. ()*
  2. The complete class name must have a top-level namespace , is called a "vendor namespace";
  3. A complete class name can have one or more sub-namespaces;
  4. A complete class name must have a final class name;
  5. A drop in any part of a complete class name Lines have no special meaning;
  6. The complete class name can be composed of any uppercase and lowercase letters;
  7. All class names must be case-sensitive.
Copy the code

When loading the corresponding file based on the complete class name

  1. In the complete class name, remove the first namespace separator, one or more consecutive namespaces and subnames in front Space, as a "namespace prefix", must correspond to at least one "file base directory";
  2. The sub-namespace immediately following the namespace prefix must match the corresponding "file base directory", in which the namespace separator will serve as the directory separator. The class name at the end of
  3. must have the same name as the corresponding file with the .php suffix.
  4. The implementation of the autoloader must not throw exceptions, must not trigger error messages at any level, and should not have a return value.
Copy code
Suggestions (please view detailed documentation for more information) PSR-1

PHP code should only define declarations such as classes, functions, constants, etc., or other operations that will produce subordinate effects (such as generating file output and modifying .ini configuration files, etc.). You can only choose one of the two;

The attribute naming of the class can follow the camel case starting with upper case ($StudlyCaps), the camel case starting with lower case ($camelCase), or the underline delimited format ($under_score). This specification does not make it mandatory, but no matter which naming is followed methods should be consistent within a certain range.

PSR-2

The number of characters per line should be softly kept within 80. In theory, it must not exceed 120, but there must be no hard limit.

Blank lines make it easier to read code and help break up code into chunks.

code example PSR-2
  1. namespace VendorPackage;
  2. use FooInterface;
  3. use BarClass as Bar;
  4. use OtherVendorOtherPackageBazClass;
  5. class Foo extends Bar implements FooInterface
  6. {
  7. public function sampleFunction($a, $b = null)
  8. {
  9. if ($a === $b) {
  10. bar();
  11. } elseif ($a > $b) {
  12. $foo->bar($arg1);
  13. } else {
  14. BazClass::bar($arg2, $arg3);
  15. }
  16. }
  17. final public static function bar()
  18. {
  19. // method body
  20. }
  21. }
Copy code
PHP, PSR


Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
How does PHP type hinting work, including scalar types, return types, union types, and nullable types?How does PHP type hinting work, including scalar types, return types, union types, and nullable types?Apr 17, 2025 am 12:25 AM

PHP type prompts to improve code quality and readability. 1) Scalar type tips: Since PHP7.0, basic data types are allowed to be specified in function parameters, such as int, float, etc. 2) Return type prompt: Ensure the consistency of the function return value type. 3) Union type prompt: Since PHP8.0, multiple types are allowed to be specified in function parameters or return values. 4) Nullable type prompt: Allows to include null values ​​and handle functions that may return null values.

How does PHP handle object cloning (clone keyword) and the __clone magic method?How does PHP handle object cloning (clone keyword) and the __clone magic method?Apr 17, 2025 am 12:24 AM

In PHP, use the clone keyword to create a copy of the object and customize the cloning behavior through the \_\_clone magic method. 1. Use the clone keyword to make a shallow copy, cloning the object's properties but not the object's properties. 2. The \_\_clone method can deeply copy nested objects to avoid shallow copying problems. 3. Pay attention to avoid circular references and performance problems in cloning, and optimize cloning operations to improve efficiency.

PHP vs. Python: Use Cases and ApplicationsPHP vs. Python: Use Cases and ApplicationsApr 17, 2025 am 12:23 AM

PHP is suitable for web development and content management systems, and Python is suitable for data science, machine learning and automation scripts. 1.PHP performs well in building fast and scalable websites and applications and is commonly used in CMS such as WordPress. 2. Python has performed outstandingly in the fields of data science and machine learning, with rich libraries such as NumPy and TensorFlow.

Describe different HTTP caching headers (e.g., Cache-Control, ETag, Last-Modified).Describe different HTTP caching headers (e.g., Cache-Control, ETag, Last-Modified).Apr 17, 2025 am 12:22 AM

Key players in HTTP cache headers include Cache-Control, ETag, and Last-Modified. 1.Cache-Control is used to control caching policies. Example: Cache-Control:max-age=3600,public. 2. ETag verifies resource changes through unique identifiers, example: ETag: "686897696a7c876b7e". 3.Last-Modified indicates the resource's last modification time, example: Last-Modified:Wed,21Oct201507:28:00GMT.

Explain secure password hashing in PHP (e.g., password_hash, password_verify). Why not use MD5 or SHA1?Explain secure password hashing in PHP (e.g., password_hash, password_verify). Why not use MD5 or SHA1?Apr 17, 2025 am 12:06 AM

In PHP, password_hash and password_verify functions should be used to implement secure password hashing, and MD5 or SHA1 should not be used. 1) password_hash generates a hash containing salt values ​​to enhance security. 2) Password_verify verify password and ensure security by comparing hash values. 3) MD5 and SHA1 are vulnerable and lack salt values, and are not suitable for modern password security.

PHP: An Introduction to the Server-Side Scripting LanguagePHP: An Introduction to the Server-Side Scripting LanguageApr 16, 2025 am 12:18 AM

PHP is a server-side scripting language used for dynamic web development and server-side applications. 1.PHP is an interpreted language that does not require compilation and is suitable for rapid development. 2. PHP code is embedded in HTML, making it easy to develop web pages. 3. PHP processes server-side logic, generates HTML output, and supports user interaction and data processing. 4. PHP can interact with the database, process form submission, and execute server-side tasks.

PHP and the Web: Exploring its Long-Term ImpactPHP and the Web: Exploring its Long-Term ImpactApr 16, 2025 am 12:17 AM

PHP has shaped the network over the past few decades and will continue to play an important role in web development. 1) PHP originated in 1994 and has become the first choice for developers due to its ease of use and seamless integration with MySQL. 2) Its core functions include generating dynamic content and integrating with the database, allowing the website to be updated in real time and displayed in personalized manner. 3) The wide application and ecosystem of PHP have driven its long-term impact, but it also faces version updates and security challenges. 4) Performance improvements in recent years, such as the release of PHP7, enable it to compete with modern languages. 5) In the future, PHP needs to deal with new challenges such as containerization and microservices, but its flexibility and active community make it adaptable.

Why Use PHP? Advantages and Benefits ExplainedWhy Use PHP? Advantages and Benefits ExplainedApr 16, 2025 am 12:16 AM

The core benefits of PHP include ease of learning, strong web development support, rich libraries and frameworks, high performance and scalability, cross-platform compatibility, and cost-effectiveness. 1) Easy to learn and use, suitable for beginners; 2) Good integration with web servers and supports multiple databases; 3) Have powerful frameworks such as Laravel; 4) High performance can be achieved through optimization; 5) Support multiple operating systems; 6) Open source to reduce development costs.

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
1 months agoBy尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Best Graphic Settings
1 months agoBy尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. How to Fix Audio if You Can't Hear Anyone
1 months agoBy尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Chat Commands and How to Use Them
1 months agoBy尊渡假赌尊渡假赌尊渡假赌

Hot Tools

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

EditPlus Chinese cracked version

EditPlus Chinese cracked version

Small size, syntax highlighting, does not support code prompt function

Safe Exam Browser

Safe Exam Browser

Safe Exam Browser is a secure browser environment for taking online exams securely. This software turns any computer into a secure workstation. It controls access to any utility and prevents students from using unauthorized resources.

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools