PHP의 몇 가지 표준 예제 공유

이 기사에서는 주로 PHP의 몇 가지 표준 예제를 공유합니다. 그것이 모두에게 도움이 되기를 바랍니다. 사양을 작성할 때 다음 사항에 유의하십시오. 일반적으로 두 가지 모두 허용되는 상황은 없어야 합니다. 예를 들어 탭과 공백 4개가 모두 작동하지만 결과적으로 코드가 혼란스러워집니다.

일반 원칙:
1. 의미
이름을 보면 의미를 알 수 있습니다.

2. 공통 접두사
is는 여부를 의미하고, get은 읽기를 의미하며, set은 쓰기를 의미합니다. is 다음에는 명사가 아닌 형용사가 먼저 옵니다. 예를 들어 텍스트가 다국어인 경우 is_multilingual 대신 is_multilingual을 사용해야 합니다.

3. 단수 및 복수
js의 함수 명명 규칙(getElementById, getElementsByTagName, getElementsByName)을 참조하세요.
예:
여러 친구의 이름을 얻으려면 getFriendNames 또는 getFriendName 대신 getFriendsName을 사용해야 합니다.
사용자를 얻으려면 getUser입니다.
여러 사용자를 얻으려면 getUsers

4입니다. 특별한 상황이 적용되지 않는 한 데이터, 목록 및 정보 접미사를 사용하지 마십시오.
예를 들어 js 이름 지정에 주의하세요. getElementsInfoByTagName 대신 getElementsByTagName을 사용하세요.
getFriendsList 대신 getFriends 또는 getFriendsUserId를 사용해야 합니다. getUserInfo 또는 getUserData 대신 getUser를 사용해야 합니다.
하지만 때로는 피하기 어려울 때도 있습니다. 예를 들어 사용자의 기본 정보를 가져오는 기능과 사용자의 세부 정보를 가져오는 기능이 있습니다.
기본 사용자 정보 얻기: 닉네임, 아바타 URI, 함수 이름 getUserBasic 또는 getUserBasicInfo? 형용사로 끝나는 함수 이름은 부적절하다고 느껴집니다. 논의할 예정입니다. 토론 결과: getUserBasicInfo가 적합합니다.
사용자 세부정보 가져오기: 닉네임, 아바타 URI, 서명, 생일, 함수 이름 getUser는 문제가 없습니다.

5. 모호한 클래스 이름, 파일 이름, 디렉토리 이름
common, util, function, class, object, basic을 파일 이름으로 사용할 때마다 주의하세요. 이러한 단어는 너무 흔하기 때문에 점점 더 많은 것들이 있을 수 있습니다. 더 많이 발전할수록 더 많은 쓰레기통이 됩니다. 예를 들어 문자열 처리를 수행하는 클래스는 StringLib.php라고 하며 lib 디렉터리에 배치할 수 있습니다.

6. lib, 플러그인, 애드온의 차이점
일부 클래스와 함수는 lib, 플러그인, 애드온으로 간주됩니다. 논의할 예정입니다. 논의 결과: 현재 개선 기능은 Lib이며, 플러그인과 애드온은 추후에 고려하겠습니다.

7. 자주 사용되는 어휘
URL 대신 URI를 먼저 사용하세요. 더욱 엄격해지면서 새로운 이름에는 URI를 사용하기 시작했습니다. 예를 들어, js의 encodeURI, PHP의 $_SERVER['REQUEST_URI'].
마감일 및 TTL: 마감일은 마지막 순간을 나타내고 TTL은 생존 시간을 나타냅니다. 예를 들어 현재 시간이 1310449710이고 TTL이 60초인 경우 마감 시간은 1310449710 + 60 = 1310449770입니다.

클래스 이름:
대문자로 시작하고 카멜 케이스로 이름을 지정하세요. 일반적으로 ParseConfig 대신 구성 구문 분석 클래스 ConfigParser와 같은 명사를 사용합니다.
Java 및 C++와 동일합니다.
예: class UserModel

클래스 파일 이름:
클래스 이름과 동일합니다. 이는 PHP 자동 로드와 관련이 있습니다. 자동 로드를 위해서는 클래스 이름이 항상 매우 길어야 합니다. 논의할 예정입니다. 논의 결과: Camel Case를 준수하면 자동 클래스 로딩도 가능합니다.
Java와 일치합니다.
예: UserModel 클래스의 파일 이름은 UserModel.php

클래스가 아닌 파일 이름:
모두 소문자, 밑줄로 구분, 공백은 허용되지 않습니다. 예를 들어 get_user.php.

디렉토리 이름:
모두 소문자, 밑줄로 구분, 공백은 허용되지 않습니다. 모델, www.

함수 이름:
소문자로 시작하고 낙타 표기로 이름을 지정하세요. 예: function addBlog().
Java 및 C++와 동일합니다.
Function은 함수, 즉 동작을 나타내므로 동사가 우선합니다. 예를 들어 blogEdit 대신 editBlog를 사용하세요.
역사적 이유로 인해 PHP의 내장 함수에는 do_something, Something_do, dosomething과 같은 다양한 스타일이 있습니다. 최신 함수는 현재 주류 언어와 일관성을 유지하기 위해 doSomething을 사용합니다.
예: paser_str, json_encode, substr, fetchAll.
역사적 이유는 변경될 수 없지만 새로운 코드가 엄격하게 적용되어 역사적 이유가 되지 않도록 할 수 있습니다.

수업 내 함수:
두 함수 사이에 빈 줄이 있습니다. 시간이 있으면 너무 많은 혼란을 피하기 위해 함수를 알파벳순으로 정렬하십시오.
예:

class BlogModel
{
    public function addBlog()
    {

    }
    
    public function updateBlog()
    {

    }
}

파일 설명:
설명은 4ccbcfc01672eb2b7f18531e9fb72947，不使用短标签b26da186e11666e6dd99f28d6205715c。因为与xml冲突，且不利于部署。

类大括号换行：

可以采用大括号单独占一行，也可以大括号与别的放在一行，有争议无定论，待讨论。讨论结果：使用“同行”。

class UserModel {

}

支持换行者：
http://www.php.net/manual/zh/language.oop5.basic.php
http://pear.php.net/manual/en/standards.classdef.php

函数大括号换行：
有争议无定论，待讨论。讨论结果：使用“同行”。

function getUser() {

}

支持换行者：
http://www.php.net/manual/zh/language.oop5.basic.php
http://pear.php.net/manual/en/standards.funcdef.php

if大括号换行：
有争议无定论，待讨论。讨论结果：使用“同行”。
例如：

if(!empty($name)){

}

或者

if(!empty($name)) { //确定

}

支持换行者：
http://www.possibility.com/Cpp/CppCodingStandard.html#brace
http://www.php.net/manual/zh/language.oop5.basic.php
http://pear.php.net/manual/en/standards.control.php
switch大括号换行：
讨论结果：使用“同行”。

switch (...) {
    case 1:
        ...
        break;

    default:
}

支持换行者：
http://www.possibility.com/Cpp/CppCodingStandard.html#switch

数组小括号换行：
有争议无定论。讨论结果：使用“同行”。

$user = array(
    "id" => "123",
    "name" => "user1",
    "email" => "a@example.com",
)

支持同行者：
http://pear.php.net/manual/en/standards.arrays.php

数组内部换行：
2维及以上数组的数组内部换行。
如：

$user = array(
    'id' => '123',
    'name' => 'user1',
    'email' => 'a@example.com',
);

1维数组内部不换行。讨论结果：1维数组内部不换行。
如：

$users_id = array('23','12','24');//确定

数组最后的逗号：
数组每一行最后要有逗号，这样方便以后添加。不过前端JSON最后不能有逗号，否则有的浏览器不支持，待讨论。讨论结果：都行，因为后端不用考虑IE前端。
比如

$user = array(
    'id' => '123',
    'name' => 'user1', //都行，优点：大数组，经常添加一行，方便。如果没有逗号，确实太难以添加了。
);
$user = array(
    'id' => '123',
    'name' => 'user1' //都行，优点：严谨，逗号表示分隔，最后一个不需要分隔。
);

单引号与双引号：
优先使用单引号，当需要转义时使用双引号，变量不放在双引号中。这与JSON不同，JSON全是双引号，待讨论。讨论结果：优先使用单引号。
比如：

echo 'name is:' . $name . '.' . "\n";
$user = array(
    'id' => '123',
);

条件判断的大括号：
必须有大括号，即使只有一行。
正确：

if(!empty($name)){
    doSomething();
}

错误：

if(!empty($name))
    doSomething();

回车换行：
使用换行LF（\n，0a，Unix风格）。不使用CR+LF（Windows风格）。
参考：http://zh.wikipedia.org/zh-cn/%E6%8F%9B%E8%A1%8C
eclipse——》workspace——》New text file line delimiter——》Other：Unix

编码：
使用UTF-8 no BOM。不得使用Windows记事本进行保存，因为记事本是UTF-8 BOM CR+LF。
eclipse——》workspace——》Text file encoding——》Other：UTF-8

缩进：
使用4个空格进行缩进，也可以采用tab进行缩进。讨论结果：4个空格。
支持4个空格者：//确定
http://www.oracle.com/technetwork/java/codeconventions-136091.html#262

支持2个空格者：
http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Spaces_vs._Tabs

支持3、4或8个空格者：

http://www.possibility.com/Cpp/CppCodingStandard.html#indent

要保证缩进正确，如果使用4个空格，一定不要出现5个空格或者11个空格。
eclipse——》General——》Editor——》Text Editors——》show whitespace characters
vim ~/.vimrc
set expandtab
set softtabstop=4
set shiftwidth=4
set autoindent

HTTP协议缓存：
文章使用Last Modified表示最后修改时间，不禁止缓存。

header('Last Modified:Sat, 30 Oct 2010 13:21:21 GMT');

需要用户登录的页面，禁止缓存。

header('Cache-Control:max-age=0');
header('Cache-Control:private');

HTTP协议编码与mime：
HTTP输出一定要声明编码与mime。charset与分号之间要有一个空格。小写utf-8还是大写UTF-8，尚未找到文档，待调研。
比如

header('Content-Type:application/json; charset=UTF-8');
header('Content-Type:application/xml; charset=UTF-8');
header('Content-Type:application/xhtml+xml; charset=UTF-8');
header('Content-Type:text/plain; charset=UTF-8');
header('Content-Type:text/html; charset=UTF-8');

专有名词大小写：
在类、函数、文件名、目录名等各种地方，不特殊对待专有名词，不采用全大写。讨论结果：使用小写。
原因：专有名词难以界定，比如HTML、CSS、CRUD。而且全大写导致与驼峰冲突，比如页面助手类，全大写是HTMLHelper，不如HtmlHelper。
支持不特殊处理：
HTML是专有名词，但mime中就使用Content-Type:text/html，而不是text/HTML。
例子：
采用UserDb.php，而不是UserDB.php。

相关推荐：

php规范解析

위 내용은 PHP의 몇 가지 표준 예제 공유의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!