Home Backend Development PHP Tutorial Detailed explanation of PHP development specification examples

Detailed explanation of PHP development specification examples

Feb 06, 2018 pm 04:17 PM
php Example Detailed explanation

This article mainly shares with you detailed examples of PHP development specifications, hoping to help everyone.

Source file

The code starts with

The file format must be BOM-free UTF-8 format

A file only declares one type. For example, class and interface cannot be mixed in one source file.

Indentation

Use 4 spaces to indent, IDE can set

line length

120 characters per line

Keywords

All keywords are lowercase, such as true, false

Naming

The class name is in camel case, such as UserModel

Class method names are in CamelCase, such as getUserId()

Function uses a combination of lowercase letters plus _, such as get_cookie()

Variable names use CamelCase Method, such as $userId

Constant is defined as a combination of uppercase letters plus _, such as IS_DEBUG

code comment label

in the class file Annotate classes, methods, and properties. Use @param @return @throwns

@param annotation to write detailed explanations, such as @param string $username username

Business module

Routes are composed of lowercase letters plus _, such as /api/get_user_info

The View layer is responsible for data display

The Controller layer is responsible for input parameters Verification, the outermost layer captures exceptions, calls the Logic and View layers

The Logic layer is responsible for specific business logic, calls the Model layer, and returns the processing data

The Model layer is responsible Data table query and association

Exception classes need to distinguish functions. For example, ParamException indicates parameter errors, UserException indicates custom exceptions

Exceptions need to be classified and defined code, use PHP classes Replace with constants, such as


<?php
namespace app\exceptions\codes;

class UserExceptionCode extends BaseExceptionCode {
  const NO_AUTH       = 1000001;
  const NO_AUTH_MSG     = &#39;不具有权限&#39;;
  const STATUS_EXCEPTION   = 1000002;
  const STATUS_EXCEPTION_MSG = &#39;状态异常&#39;;    
}
Copy after login

If the data table file has an Enum type, use PHP class constants instead, such as


<?php
namespace app\enums;

class UserEnum extends BaseEnum {
  const STATUS_DELETED = -1;// 已删除
  const STATUS_DISABLE = 0;// 禁用
  const STATUS_ENABLE = 1;// 正常

  const AUTH_GUEST     = 1;// 匿名用户
  const AUTH_GENERAL_ADMIN = 2;// 普通管理员
  const AUTH_SUPER_ADMIN  = 3;// 超级管理员
}
Copy after login

Where STATUS and AUTH are the data table mapping field names

Api interface output, example


##

{
  "code" : 0,
  "msg" : "success",
  "data" : {
    "userId" : 100
  }
}
Copy after login

where code and msg are required fields, Do not fill in if data is empty, example


{
  "code" : 100001,
  "msg" : "不具有权限"
}
Copy after login

Other


array, use single quotes when the key is a string, there is only one key Use a single line when using multiple keys, example


$arr = [ &#39;userId&#39; => 100 ];
Copy after login

Use multiple lines when using multiple keys, use a single line when using strings like


$arr = [
  &#39;id&#39;    => 100,
  &#39;username&#39; => &#39;admin&#39;,
];
Copy after login
Quotation marks '

Related recommendations:

php code PHP development specification manual PHP code specification detailed explanation

Summary of PHP development specification

Detailed Explanation of PHP Code Specifications in the PHP Development Specification Manual

The above is the detailed content of Detailed explanation of PHP development specification examples. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
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

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

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

PHP 8.4 Installation and Upgrade guide for Ubuntu and Debian 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 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 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. 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,

How do you parse and process HTML/XML in PHP? 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

PHP Program to Count Vowels in a String 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

Explain late static binding in PHP (static::). 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? 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.

See all articles