Backend Development
PHP Tutorial
Introduction to PHP coding development specifications (with examples)
Introduction to PHP coding development specifications (with examples)
This article brings you an introduction to PHP coding development specifications (with examples). It has certain reference value. Friends in need can refer to it. I hope it will be helpful to you.
In the past few days, I have been reading a set of Java development specifications "Alibaba Java Development Manual" released by Alibaba Technology. It contains Alibaba's internal Java development specifications and standards, and it is very well written. This set of Java unified specifications will help improve the standardization level of industry coding, help industry personnel improve development quality and efficiency, and greatly reduce code maintenance costs.
After reading this, I searched for some PHP development specifications and standards, and learned that the PSR specification is a set of development standards commonly used in the PHP industry. I lament that I have learned so little and discovered the standard norms so late.
In fact, for novices or developers with several years of experience, we must master these specifications. In many cases, if we do these specifications well, in collaborative development, we can improve the quality and efficiency of our development.
What is PSR?
PSR is the abbreviation of PHP Standard Recommendations. The PHP specification developed by the PHP FIG organization is the practice standard for PHP development.
PHP FIG has currently voted to adopt 6 sets of standards and has been supported and recognized by most PHP frameworks.
Among them, the ones that have passed are:
- PSR-1 basic coding specification
- PSR-2 coding style specification
- PSR-3 log interface specification
- PSR-4 automatic loading specification
- PSR-6 cache interface specification
- PSR-7 HTTP message interface specification
*Note: PSR-0 has been deprecated and PSR-5 is still being drafted and will be added later
Here we first introduce the PSR-1 basic coding specifications
1. Overview
PHP code files must end with
PHP code files must be encoded in UTF-8 without BOM;
PHP code should only define declarations such as classes, functions, constants, etc., or For other operations that will produce side effects (such as generating file output and modifying .ini configuration files, etc.), you can only choose one of the two;
namespaces and classes must comply with PSR's automatic loading specification: One of [PSR-4](); the naming of the
class must follow the camel case naming convention of StudlyCaps starting with an uppercase letter; all letters of the constants in the
class must be Capitalize, and use underscores to separate words;
method names must conform to camelCase-style camelCase naming convention starting with lowercase.
2. File
##2.1. PHP tag
PHP code must use long tag Or short output tag; must not use other custom tags.2.2. Character encoding
PHP code must and can only use UTF-8 encoding without BOM. (This is very important)2.3. Side Effects
A PHP file should only define new declarations, such as classes, functions or constants, etc. Operations that produce side effects, or just write logical operations that produce side effects, but not both at the same time. The term "side effects" means logical operations performed only by including files without directly declaring classes, functions, constants, etc. "Side effects" include but are not limited to:- Generate output
- Direct require or include
- Connect to external services
- Modify ini configuration
- Throw an error or exception
- Modify global or static variables
- Read or write files, etc.
<?php
// 「副作用」：修改 ini 配置
ini_set('error_reporting', E_ALL);
// 「副作用」：引入文件
include "file.php";
// 「副作用」：生成输出
echo "<html>\n";
// 声明函数
function foo()
{
// 函数主体部分
}<?php
// 声明函数
function foo()
{
// 函数主体部分
}
// 条件声明 **不** 属于「副作用」
if (! function_exists('bar')) {
function bar()
{
// 函数主体部分
}
}3. Namespaces and classes
The naming of namespaces and classes must follow [PSR-4](). According to the specification, each class is an independent file, and the namespace has at least one level: the top-level organization name (vendor name). The naming of classes must follow the camel case naming convention of StudlyCaps starting with an uppercase letter. Code for PHP 5.3 and later versions must use formal namespaces. For example:<?php
// PHP 5.3及以后版本的写法
namespace Vendor\Model;
class Foo
{
}5.2.x 及之前的版本 应该 使用伪命名空间的写法，约定俗成使用顶级的组织名称（vendor name）如 Vendor_ 为类前缀。
<?php
// 5.2.x及之前版本的写法
class Vendor_Model_Foo
{
}4. 类的常量、属性和方法
此处的「类」指代所有的类、接口以及可复用代码块（traits）。
4.1. 常量
类的常量中所有字母都 必须 大写，词间以下划线分隔。
参照以下代码：
<?php
namespace Vendor\Model;
class Foo
{
const VERSION = '1.0';
const DATE_APPROVED = '2012-06-01';
}4.2. 属性
类的属性命名 可以 遵循：
- 大写开头的驼峰式 ($StudlyCaps)
- 小写开头的驼峰式 ($camelCase)
- 下划线分隔式 ($under_score)
本规范不做强制要求，但无论遵循哪种命名方式，都 应该 在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。
4.3. 方法
方法名称 必须 符合 camelCase() 式的小写开头驼峰命名规范。
【相关推荐：PHP视频教程】
The above is the detailed content of Introduction to PHP coding development specifications (with examples). For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Undress AI Tool
Undress images for free
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
Hot Topics
PHP 8.4 Installation and Upgrade guide for Ubuntu and Debian
Dec 24, 2024 pm 04:42 PM
PHP 8.4 brings several new features, security improvements, and performance improvements with healthy amounts of feature deprecations and removals. This guide explains how to install PHP 8.4 or upgrade to PHP 8.4 on Ubuntu, Debian, or their derivati
7 PHP Functions I Regret I Didn't Know Before
Nov 13, 2024 am 09:42 AM
If you are an experienced PHP developer, you might have the feeling that you’ve been there and done that already.You have developed a significant number of applications, debugged millions of lines of code, and tweaked a bunch of scripts to achieve op
How To Set Up Visual Studio Code (VS Code) for PHP Development
Dec 20, 2024 am 11:31 AM
Visual Studio Code, also known as VS Code, is a free source code editor — or integrated development environment (IDE) — available for all major operating systems. With a large collection of extensions for many programming languages, VS Code can be c
Explain JSON Web Tokens (JWT) and their use case in PHP APIs.
Apr 05, 2025 am 12:04 AM
JWT is an open standard based on JSON, used to securely transmit information between parties, mainly for identity authentication and information exchange. 1. JWT consists of three parts: Header, Payload and Signature. 2. The working principle of JWT includes three steps: generating JWT, verifying JWT and parsing Payload. 3. When using JWT for authentication in PHP, JWT can be generated and verified, and user role and permission information can be included in advanced usage. 4. Common errors include signature verification failure, token expiration, and payload oversized. Debugging skills include using debugging tools and logging. 5. Performance optimization and best practices include using appropriate signature algorithms, setting validity periods reasonably,
PHP Program to Count Vowels in a String
Feb 07, 2025 pm 12:12 PM
A string is a sequence of characters, including letters, numbers, and symbols. This tutorial will learn how to calculate the number of vowels in a given string in PHP using different methods. The vowels in English are a, e, i, o, u, and they can be uppercase or lowercase. What is a vowel? Vowels are alphabetic characters that represent a specific pronunciation. There are five vowels in English, including uppercase and lowercase: a, e, i, o, u Example 1 Input: String = "Tutorialspoint" Output: 6 explain The vowels in the string "Tutorialspoint" are u, o, i, a, o, i. There are 6 yuan in total
How do you parse and process HTML/XML in PHP?
Feb 07, 2025 am 11:57 AM
This tutorial demonstrates how to efficiently process XML documents using PHP. XML (eXtensible Markup Language) is a versatile text-based markup language designed for both human readability and machine parsing. It's commonly used for data storage an
Explain late static binding in PHP (static::).
Apr 03, 2025 am 12:04 AM
Static binding (static::) implements late static binding (LSB) in PHP, allowing calling classes to be referenced in static contexts rather than defining classes. 1) The parsing process is performed at runtime, 2) Look up the call class in the inheritance relationship, 3) It may bring performance overhead.
What are PHP magic methods (__construct, __destruct, __call, __get, __set, etc.) and provide use cases?
Apr 03, 2025 am 12:03 AM
What are the magic methods of PHP? PHP's magic methods include: 1.\_\_construct, used to initialize objects; 2.\_\_destruct, used to clean up resources; 3.\_\_call, handle non-existent method calls; 4.\_\_get, implement dynamic attribute access; 5.\_\_set, implement dynamic attribute settings. These methods are automatically called in certain situations, improving code flexibility and efficiency.
