大家好，我是编程小6，很高兴遇见你，有问题可以及时留言哦。

PHP开发编码规范

编写目的

为了更好的提高技术部的工作效率，保证开发的有效性和合理性，并可最大程度的提高程序代码的可读性和可重复利用性，指定此规范。开发团队根据自己的实际情况，可以对本规范进行补充或裁减。

PHP整体要求

PHP开发编码规范 整体要求

技术部php开发规范将参照PEAR的规范，基本采用PEAR指定的规范，在其基础上增加、修改或删除部分适合具体开发环境的规范。本规范只针对PHP开发过程中编码的规范，对于PHP开发项目中文件、目录、数据库等方面的规范，将不重点涉及。
本规范包含了PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。

PHP安全规范

3.1.1 PHP命名规则

提取出来具有通用函数的包含文件，文件后缀以.inc来命名，表明这是一个包含文件。
如果有多个.inc文件需要包含多页面，请把所有.inc文件封装在一个文件里面，具体到页面只需要包换一个.inc文件就可以了
如:xxx_session.inc
xxx_comm..inc
xxx_setting.inc
mysql_db.inc

把以上文件以一下方式，封装在xxx.basic.inc文件里面
require_once(”xxx_session.inc”);
require_once(”xxx_comm.inc”);
require_once(”xxx_setting.inc”);
require_once(”mysql_db.inc”);

注：是否需要封装到一个文件，视情况而定，如果每个inc的功能是分散到不同的页面使用的话，就不建议封装。

3.1.2 PHP存放规则

一般包含文件不需要直接暴露给用户，所以应该放在 Web Server访问不到的目录，避免因为配置问题而泄露设置信息。

3.2 PHP安全规则

输入和输出
检查是否做了HTML代码的过滤
可能出现的问题：如果有人输入恶意的HTML代码，会导致窃取cookie, 产生恶意登录表单，和破坏网站\检查变量做数据库操作之前是否做了escape可能出现的问题：如果一个要写入查询语句的字符串变量包含了某些特殊的字符，比如引号(’ ,”)或者分号(;) 可能造成执行了预期之外的操作。
建议采用的方法：使用mysql_escape_string() 或是实现类似功能的函数。
检查输入数值的合法性
可能出现的问题：异常的数值会造成问题。如果对输入的数值不做检查会造成不合法的或者错误的数据存入UDB、存入其它的数据库或者导致意料之外的程序操作发生。
举例：
如果程序以用户输入的参数值作为文件名，进行文件操作，恶意输入系统文件名会造成系统损毁。
核实对cookie的使用以及对用户数据的处理
可能出现的问题：不正确的cookie使用可能造成用户数据泄漏
访问控制
对内部使用的产品或者供合作方使用的产品，要考虑增加访问控制
logs
确保用户的保密信息没有记在log中(例如：用户的密码)
确保对关键的用户操作保存了完整的用户访问记录
https
对敏感数据的传输要采用https

3.3 一些针对PHP的规则

设置 register_globals = off (Y!PHP 已经禁止了register_globals，如果你使用Y!PHP可以不考虑这项设置)
设置 error_reporting = E_ALL (Y!PHP 的缺省设置），并且要修正所有的error和warning
将实际的操作放在被引用的文件中。把引用文件放到不可以被直接浏览的目录下

3.4 PHP其它处理规则

3.4.1 PHP对输入参数值进行转义处理

页面接到参数需要SQL操作，这时候需要做转义，尤其需要注意”;”。
如：$a = ” Let’s go ” ;
$sql = “Insert into tmp(col) values(’$a’)” ;
这种情况出现错误的不确定性。

3.4.2 PHP操作大HTML文本

很多时候需要存放一大段HTML文本供页面使用，象用户定制页头页脚等。
需要剔除脚本标记，避免执行恶意php代码。
转换”<"">“号，保证代码完整。

PHP编码规范

4.1 PHP命名规范

制定统一的命名规范对于项目开发来说非常重要，不但可以养成程序员一个良好的开发习惯，还能增加程序的可读性、可移植性和可重用性，还能很好的提高项目开发的效率。

4.1.1 PHP 变量命名

变量命名分为普通变量、静态变量、局部变量、全局变量、Session变量等方面的命名规则。

1) 普通变量
普通变量命名遵循以下规则：
a． 所有字母都使用小写；
b． 对于一个变量使用多个单词的，使用’_'作为每个词的间隔。
例如：$base_dir、$red_rose_price等

2) 静态变量
静态变量命名遵循以下规则：
a． 静态变量使用小写的s_开头；
b． 静态变量所有字母都使用小写；
c． 多个单词组成的变量名使用’_'作为每个词的间隔。
例子：$s_base_dir、$s_red_rose_prise等。

3) 局部变量
局部变量命名遵循以下规则：
a． 所有字母使用小写；
b． 变量使用’_'开头；
c． 多个单词组成的局部变量名使用’_'作为每个词间的间隔。
例子：$_base_dir、$_red_rose_price等。

4) 全局变量
全局变量应该带前缀’g',知道一个变量的作用域是非常重要的。
例如
global $gLOG_LEVEL;
global $gLOG_PATH;

5) 全局常量
全局变量命名遵循以下规则：
a． 所有字母使用大写
b． 全局变量多个单词间使用’_'作为间隔。
例子：$BASE_DIR、$RED_ROSE_PRICE等。

6) session变量
session变量命名遵循以下规则：
a． 所有字母使用大写；
b． session变量名使用’S_’开头；
c． 多个单词间使用’_'间隔。
例子：$S_BASE_DIR、$S_RED_ROSE_PRICE等。

4.1.2 PHP 类命名

php中类命名遵循以下规则：
a． 以大写字母开头；
b． 多个单词组成的变量名，单词之间不用间隔，各个单词首字母大写。
例子：class MyClass 或class DbOracle等。

4.1.3 PHP 方法或函数

方法或函数命名遵循以下规则：
a． 首字母小写；
b． 多个单词间不使用间隔，除第一个单词外，其他单词首字母大写。
例子：function myFunction ()或function myDbOracle ()等。

4.1.4 PHP 缩写词

当变量名或者其他命名中遇到缩写词时，参照具体的命名规则，而不采用缩写词原来的全部大写的方式。
例子：function myPear（不是myPEAR） functio getHtmlSource（不是getHTMLSource）。

4.1.5 PHP 数据库表名

数据库表名命名遵循以下规范：
a． 表名均使用小写字母；
b． 数据表都要统一加前缀；
c．对于多个单词组成的表名，使用_间隔；
例子：yuncms_user_info和tp_book_store等

4.1.6 PHP 数据库字段

数据库字段命名遵循以下规范：
a． 全部使用小写；
b． 多个单词间使用_间隔。
例子：user_name、rose_price等。

4.2 PHP书写规则

书写规则是指在编写php程序时，代码书写的规则，包括缩进、结构控制等方面规范：

4.2.1 PHP 代码缩进

在书写代码的时候，必须注意代码的缩进规则，我们规定代码缩进规则如下：
a． 使用4个空格作为缩进，或使用tab缩进（对于ultraedit，可以进行预先设置）
例子：

for ( $i=0;$i<$count;$i++ ){

echo "test";

}

4.2.2 PHP 大括号{ }书写规则

在程序中进行结构控制代码编写，如if、for、while、switch等结构，大括号传统的有两种书写习惯，分别如下：
a．{直接跟在控制语句之后，不换行，如

for ($i=0;$i<$count;$i++) {

echo "test";

}

b．{在控制语句下一行，如

for($i=0;$i<$count;$i++){

echo "test";

}

其中，a是PEAR建议的方式，但是从实际书写中来讲，这并不影响程序的规范和影响用phpdoc实现文档，所以可以根据个人习惯来采用上面的两种方式，但是要求在同一个程序中，只使用其中一种，以免造成阅读的不方便。

4.2.3 PHP 小括号( )和函数、关键词等

小括号、关键词和函数遵循以下规则：
a． 不要把小括号和关键词紧贴在一起，要用一个空格间隔；如if ( $a<$b )；
b． 小括号和函数名间没有空格；如$test = date("ymdhis")；
c． 除非必要，不要在Return返回语句中使用小括号。 如return $a；

4.2.4 PHP ＝符号书写

在程序中=符号的书写遵循以下规则：
a． 在=符号的两侧，均需留出一个空格；如$a = $b 、if ($a = = $b)等；
b． 在一个申明块，或者实现同样功能的一个块中，要求=号尽量上下对其，左边可以为了保持对齐使用多个空格，而右边要求空一个空格；如下例：

$testa = $aaa;

$testaa = $bbb;

$testaaa = $ccc;

4.2.5 PHP if else swith for while等书写

对于控制结构的书写遵循以下规则：
a． 在if条件判断中，如果用到常量判断条件，将常量放在等号或不等号的左边，例如：
if ( 6 == $errorNum )，因为如果你在等式中漏了一个等号，语法检查器会为你报错，可以很快找到错误位置，这样的写法要多注意；
b． switch结构中必须要有default块；
c． 在for和wiile的循环使用中，要警惕continue、break的使用，避免产生类似goto的问题；

4.2.6 PHP 类的构造函数

如果要在类里面编写构造函数，必须遵循以下规则：
a．不能在构造函数中有太多实际操作，顶多用来初始化一些值和变量；
b．不能在构造函数中因为使用操作而返回false或者错误，因为在声明和实例化一个对象的时候，是不能返回错误的；

4.2.7 PHP 语句断行, 每行控制在80个字符以内

在代码书写中，遵循以下原则：
a． 尽量保证程序语句一行就是一句，而不要让一行语句太长产生折行；
b． 尽量不要使一行的代码太长，一般控制在80个字符以内；
c． 如果一行代码太长，请使用类似 .= 的方式断行书写；
d． 对于执行数据库的sql语句操作，尽量不要在函数内写sql语句，而先用变量定义sql语句，然后在执行操作的函数中调用定义的变量；
例子：

$sql = "SELECT username,password,address,age,postcode FROM test_t ";

$sql .= " WHERE username='aaa'";

$res = mysql_query($sql);

4.2.8 PHP 不要不可思议的数字

一个在源代码中使用了的赤裸裸的数字是不可思议的数字，因为包括作者，在三个月内，没人它的含义。例如：

if (22 == $foo) {

start_thermo_nuclear_war();

}

else if (19 == $foo){

refund_lotso_money();

}

else{

cry_cause_im_lost();

}

你应该用define()来给你想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，例如：

define("PRESIDENT_WENT_CRAZY", "22");

define("WE_GOOFED", "19");

define("THEY_DIDNT_PAY", "16");

if ( PRESIDENT_WENT_CRAZY == $foo) {

start_thermo_nuclear_war();

}

else if (WE_GOOFED == $foo) {

refund_lotso_money();

}

else if (THEY_DIDNT_PAY == $foo)

{

infinite_loop();

}

else{

happy_days_i_know_why_im_here();

}

4.2.9 PHP true/false和0/1判断

遵循以下规则：
a． 不能使用0/1代替true/false，在PHP中，这是不相等的；
b． 不要使用非零的表达式、变量或者方法直接进行true/false判断，而必须使用严格的完整true/false判断；
如：不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者 if (FALSE != check())

4.2.10 PHP 避免嵌入式赋值

在程序中避免下面例子中的嵌入式赋值：
不使用这样的方式：

while ($a != ($c = getchar())){

process the character

}

4.3 PHP程序注释

每个程序均必须提供必要的注释，书写注释要求规范，参照PEAR提供的注释要求，为今后利用phpdoc生成php文档做准备。程序注释的原则如下：
a．注释中除了文件头的注释块外，其他地方都不使用//注释，而使用/* */的注释；
b．注释内容必须写在被注释对象的前面，不写在一行或者后面；

4.3.1 PHP程序头注释块

每个程序头部必须有统一的注释块，规则如下：
a． 必须包含本程序的描述；
b． 必须包含作者；
c． 必须包含书写日期；
d． 必须包含版本信息；
e． 必须包含项目名称；
f． 必须包含文件的名称；
g． 重要的使用说明，如类的调用方法、注意事项等；
参考例子如下：

<?php

//

// +---------------------------------------------------------+

// | PHP version 4.0 |

// +---------------------------------------------------------+

// | Copyright (c) 2001-2020 The PHP Group |

// +---------------------------------------------------------+

// | This source file is subject to of the PHP license, |

// | that is bundled with this packafile LICENSE, and is |

// | available at through the world-web at |

// | http://www.php.net/license/2_02.txt. |

// | If you did not receive a copy of the and are unable to |

// | obtain it through the world-wide-web,end a note to |

// | 987772927@qq.com so we can mail you a immediately. |

// +---------------------------------------------------------+

// | Authors: Du Yun <987772927@qq.com> |

// | Li RunSheng <xxxxxxxxxx@qq.com> |

// | |

// +---------------------------------------------------------+

//

// $Id: Common.php,v 1.8.2.3 2018/09/13 01:26:48 ssb Exp $

4.3.2 PHP类的注释

/**

* @ Purpose:

* 访问数据库的类，以ODBC作为通用访问接口

* @Package Name: Database

* @Author: Du Yun 987772927@qq.com

* @Modifications:

* No20020523-100:

* odbc_fetch_into()参数位置第二和第三个位置调换

* @See: (参照)

*/

class Database {

……

}

4.3.3 PHP函数和方法的注释

函数和方法的注释写在函数和方法的前面，采用类似下面例子的规则：

/**

* @Purpose:

* 执行一次查询

* @Method Name: Query()

*

* @Param: string $queryStr SQL查询字符串

* @Param: string $username 用户名

*

* @Author: Du Yun

*

* @Return: mixed 查询返回值（结果集对象）

*/

function（$queryStr,$username）

{……}

4.3.4 PHP变量或者语句注释

程序中变量或者语句的注释遵循以下原则：
a． 写在变量或者语句的前面一行，而不写在同行或者后面；
b． 注释采用/* */的方式；
c． 每个函数前面要包含一个注释块。内容包括函数功能简述，输入/输出参数，预期的返回值，出错代码定义。
d． 注释完整规范。
e． 把已经注释掉的代码删除，或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。
例子：

/**

* @Purpose:

* 数据库连接用户名

* @Attribute/Variable Name: db_user_name

* @Type: string

*/

var db_user_name;

4.4 PHP其他规范（建议）

包括:

php代码标记,程序文件名、目录名, PHP项目通常的文件目录结构,PHP和HTML代码的分离问题,PHP项目开发中的程序逻辑结构等

4.4.1 php代码标记

所有的php程序代码块标记均使用

4.4.2 PHP程序文件名、目录名

程序文件名和目录名命名均采用有意义的英文方式命名，不使用拼音或无意义的字母，同时均必须使用小写字母，多个词间使用_间隔。

4.4.3 PHP项目通常的文件目录结构

建议在开发规范的独立的PHP项目时，使用规范的文件目录结构，这有助于提高项目的逻辑结构合理性，对应扩展和合作，以及团队开发均有好处。

一个完整独立的PHP项目通常的文件和目录结构如下：
project 应用部署目录

├─application 应用目录（可设置）

│ ├─common 公共模块目录（可更改）

│ ├─index 模块目录(可更改)

│ │ ├─config.php 模块配置文件

│ │ ├─common.php 模块函数文件

│ │ ├─controller 控制器目录

│ │ ├─model 模型目录

│ │ ├─view 视图目录

│ │ └─ ... 更多类库目录

│ ├─command.php 命令行工具配置文件

│ ├─common.php 应用公共（函数）文件

│ ├─config.php 应用（公共）配置文件

│ ├─database.php 数据库配置文件

│ ├─tags.php 应用行为扩展定义文件

│ └─route.php 路由配置文件

├─extend 扩展类库目录（可定义）

├─public WEB 部署目录（对外访问目录）

│ ├─static 静态资源存放目录(css,js,image)

│ ├─index.php 应用入口文件

│ ├─router.php 快速测试文件

│ └─.htaccess 用于 apache 的重写

├─runtime 应用的运行时目录（可写，可设置）

├─vendor 第三方类库目录（Composer）

├─thinkphp 框架系统目录

│ ├─lang 语言包目录

│ ├─library 框架核心类库目录

│ │ ├─think Think 类库包目录

│ │ └─traits 系统 Traits 目录

│ ├─tpl 系统模板目录

│ ├─.htaccess 用于 apache 的重写

│ ├─.travis.yml CI 定义文件

│ ├─base.php 基础定义文件

│ ├─composer.json composer 定义文件

│ ├─console.php 控制台入口文件

│ ├─convention.php 惯例配置文件

│ ├─helper.php 助手函数文件（可选）

│ ├─LICENSE.txt 授权说明文件

│ ├─phpunit.xml 单元测试配置文件

│ ├─README.md README 文件

│ └─start.php 框架引导文件

├─build.php 自动生成定义文件（参考）

├─composer.json composer 定义文件

├─LICENSE.txt 授权说明文件

├─README.md README 文件

├─think 命令行入口文件

以上目录结构是通常的目录结构，根据具体应用的具体情况，可以考虑不用完全遵循，但是尽量做到规范化。

4.4.4 PHP和HTML代码的分离问题

对性能要求不是很高的项目和应用，我们建议不采用PHP和HTML代码直接混排的方式书写代码，而采用PHP和HTML代码分离的方式，即采用模版的方式处理，这样一方面对程序逻辑结构更加清晰有利，也有助于开发过程中人员的分工安排，同时还对日后项目的页面升级该版提供更多便利。
对于一些特殊情况，比如对性能要求很高的应用，可以不采用模版方式。

4.4.5 PHP项目开发中的程序逻辑结构

对于PHP项目开发，尽量采用OOP的思想开发，尤其在PHP5以后，对于面向对象的开发功能大大提高。
在PHP项目中，我们建议将独立的功能模块尽量写成函数调用，对应一整块业务逻辑，我们建议封装成类，既可以提高代码可读性，也可以提高代码重用性。比如，我们通常将对数据库的接口封装成数据库类，有利于平台的移植。
重复的代码要做成公共的库。（除了我们在plug-in产品上遇到的情况，该产品系列有多个相类似的产品，为了尽可能地减少安装包尺寸，不适合将这些产品共用的所有函数做成公共的库）

5.1 PHP变量定义

XXX环境下的php代码编写要求所有的变量均需要先申明后使用，否则会有错误信息，对于数组，在使用一个不确定的key时，比如先进行isset()的判断，然后再使用；比如下面的代码：

$array ＝ array();

$var ＝ isset($array[3]) ? $array[3] : “”；

5.2 PHP引用的使用

引用在程序中使用比较多，为了公用同一个内存，而不需要另外进行复制，XXX环境下的引用使用时，需要注意下面的情况；
在对函数的输入参数中使用引用时，不能在调用的时候在输入参数前加&来引用，而直接使用该变量即可，同时必须在函数定义的时候说明输入参数来自引用，比如下面的代码：

$a ＝ 1；

function ab(&$var){

$var ++；

return $var；

}

$b ＝ ab($a) // 注意，此处不能使用 $b ＝ ab(&$a)的方式；

echo $b.”/n”；

echo $a.”/n”；

此时 $a和$b都是2；

XXX环境下对引用的特殊要求源自php.ini文件里面的allow_call_time_pass_reference 项设置， 对外公开的版本是 On ，这样就可以支持&直接加到调用函数时变量前面进行引用，但是这一方法遭到抗议，并可能在将来版本的PHP/Zend里不再支持。受到鼓励的指定哪些参数按引用传递的方法是在函数声明里。你被鼓励尝试关闭这一选项（使用 off，XXX的所有运行环境下都是off）并确认你的脚本仍能正常工作，以保证在将来版本的语言里它们仍能工作。

5.3 PHP变量的输入输出

在XXX环境下，对web通过GET或者POST方法传递来的参数均要求进行严格的过滤和合法性验证，不推荐使用直接的$_GET、$_POST或者$_REQUEST获取，而通过XXX的XXX_yiv模块提供的方法获取和过滤处理。

6 PHP中常见BUG，以下BUG避免出现

错误1：foreach循环后留下悬挂指针

　　在foreach循环中，如果我们需要更改迭代的元素或是为了提高效率，运用引用是一个好办法：

$arr = array(1, 2, 3, 4);

foreach ($arr as &$value) {

$value = $value * 2;

}

// $arr is now array(2, 4, 6, 8)

　　这里有个问题很多人会迷糊。循环结束后，value并未销毁，value其实是数组中最后一个元素的引用，这样在后续对$value的使用中，如果不知道这一点，会引发一些莫名奇妙的错误:)看看下面这段代码：

$array = [1, 2, 3];

echo implode(',', $array), "\n";

foreach ($array as &$value) {} // by reference

echo implode(',', $array), "\n";

foreach ($array as $value) {} // by value (i.e., copy)

echo implode(',', $array), "\n";

　　上面代码的运行结果如下：

1,2,3

1,2,3

1,2,2

　　你猜对了吗？为什么是这个结果呢？

　　我们来分析下。第一个循环过后，$value是数组中最后一个元素的引用。第二个循环开始：

第一步：复制arr[0]到value（注意此时value是arr[2]的引用），这时数组变成[1,2,1]
第二步：复制arr[1]到value，这时数组变成[1,2,2]
第三步：复制arr[2]到value，这时数组变成[1,2,2]
　　综上，最终结果就是1,2,2

　　避免这种错误最好的办法就是在循环后立即用unset函数销毁变量：

$arr = array(1, 2, 3, 4);

foreach ($arr as &$value) {

$value = $value * 2;

}

unset($value); // $value no longer references $arr[3]

　错误2：对isset()函数行为的错误理解

　　对于isset()函数，变量不存在时会返回false，变量值为null时也会返回false。这种行为很容易把人弄迷糊。。。看下面的代码：

$data = fetchRecordFromStorage($storage, $identifier);

if (!isset($data['keyShouldBeSet']) {

// do something here if 'keyShouldBeSet' is not set

}

　　写这段代码的人本意可能是如果data[′keyShouldBeSet′]未设置，则执行对应逻辑。但问题在于即使data['keyShouldBeSet']已设置，但设置的值为null，还是会执行对应的逻辑，这就不符合代码的本意了。

　　下面是另外一个例子：

if ($_POST['active']) {

$postData = extractSomething($_POST);

}

// ...

if (!isset($postData)) {

echo 'post not active';

}

　　上面的代码假设POST[′active′]为真，那么postData应该被设置，因此isset(postData)会返回true。反之，上面代码假设isset(postData)返回false的唯一途径就是$_POST['active']也返回false。

　　真是这样吗？当然不是！

　　即使POST[′active′]返回true，postData也有可能被设置为null，这时isset($postData)就会返回false。这就不符合代码的本意了。

　　如果上面代码的本意仅是检测$_POST['active']是否为真，下面这样实现会更好：

if ($_POST['active']) {

$postData = extractSomething($_POST);

}

// ...

if ($_POST['active']) {

echo 'post not active';

}

　　判断一个变量是否真正被设置（区分未设置和设置值为null），array_key_exists()函数或许更好。重构上面的第一个例子，如下：

$data = fetchRecordFromStorage($storage, $identifier);

if (! array_key_exists('keyShouldBeSet', $data)) {

// do this if 'keyShouldBeSet' isn't set

}

　　另外，结合get_defined_vars()函数，我们可以更加可靠的检测变量在当前作用域内是否被设置：

if (array_key_exists('varShouldBeSet', get_defined_vars())) {

// variable $varShouldBeSet exists in current scope

}

　错误3：混淆返回值和返回引用

　　考虑下面的代码：

class Config

{

private $values = [];

public function getValues() {

return $this->values;

}

}

$config = new Config();

$config->getValues()['test'] = 'test';

echo $config->getValues()['test'];

　　运行上面的代码，将会输出下面的内容：

PHP Notice: Undefined index: test in /path/to/my/script.php on line 21

　　问题出在哪呢？问题就在于上面的代码混淆了返回值和返回引用。在PHP中，除非你显示的指定返回引用，否则对于数组PHP是值返回，也就是数组的拷贝。因此上面代码对返回数组赋值，实际是对拷贝数组进行赋值，非原数组赋值。

// getValues() returns a COPY of the $values array, so this adds a 'test' element

// to a COPY of the $values array, but not to the $values array itself.

$config->getValues()['test'] = 'test';

// getValues() again returns ANOTHER COPY of the $values array, and THIS copy doesn't

// contain a 'test' element (which is why we get the "undefined index" message).

echo $config->getValues()['test'];

　　下面是一种可能的解决办法，输出拷贝的数组，而不是原数组：

$vals = $config->getValues();

$vals['test'] = 'test';

echo $vals['test'];

　　如果你就是想要改变原数组，也就是要反回数组引用，那应该如何处理呢？办法就是显示指定返回引用即可：

class Config

{

private $values = [];

// return a REFERENCE to the actual $values array

public function &getValues() {

return $this->values;

}

}

$config = new Config();

$config->getValues()['test'] = 'test';

echo $config->getValues()['test'];

　　经过改造后，上面代码将会像你期望那样会输出test。

　　我们再来看一个例子会让你更迷糊的例子：

class Config

{

private $values;

// using ArrayObject rather than array

public function __construct() {

$this->values = new ArrayObject();

}

public function getValues() {

return $this->values;

}

}

$config = new Config();

$config->getValues()['test'] = 'test';

echo $config->getValues()['test'];

　　如果你想的是会和上面一样输出“ Undefined index”错误，那你就错了。代码会正常输出“test”。原因在于PHP对于对象默认就是按引用返回的，而不是按值返回。

　　综上所述，我们在使用函数返回值时，要弄清楚是值返回还是引用返回。PHP中对于对象，默认是引用返回，数组和内置基本类型默认均按值返回。这个要与其它语言区别开来（很多语言对于数组是引用传递）。

　　像其它语言，比如java或C#，利用getter或setter来访问或设置类属性是一种更好的方案，当然PHP默认不支持，需要自己实现：

class Config

{

private $values = [];

public function setValue($key, $value) {

$this->values[$key] = $value;

}

public function getValue($key) {

return $this->values[$key];

}

}

$config = new Config();

$config->setValue('testKey', 'testValue');

echo $config->getValue('testKey'); // echos 'testValue'

　　上面的代码给调用者可以访问或设置数组中的任意值而不用给与数组public访问权限。感觉怎么样:)

　错误4：在循环中执行sql查询

　　在PHP编程中发现类似下面的代码并不少见：

$models = [];

foreach ($inputValues as $inputValue) {

$models[] = $valueRepository->findByValue($inputValue);

}

　　当然上面的代码是没有什么错误的。问题在于我们在迭代过程中$valueRepository->findByValue()可能每次都执行了sql查询：

$result = $connection->query("SELECT `x`,`y` FROM `values` WHERE `value`=" . $inputValue);

　　如果迭代了10000次，那么你就分别执行了10000次sql查询。如果这样的脚本在多线程程序中被调用，那很可能你的系统就挂了。。。

　　在编写代码过程中，你应该要清楚什么时候应该执行sql查询，尽可能一次sql查询取出所有数据。

　　有一种业务场景，你很可能会犯上述错误。假设一个表单提交了一系列值（假设为IDs），然后为了取出所有ID对应的数据，代码将遍历IDs，分别对每个ID执行sql查询，代码如下所示：

$data = [];

foreach ($ids as $id) {

$result = $connection->query("SELECT `x`, `y` FROM `values` WHERE `id` = " . $id);

$data[] = $result->fetch_row();

}

　　但同样的目的可以在一个sql中更加高效的完成，代码如下：

$data = [];

if (count($ids)) {

$result = $connection->query("SELECT `x`, `y` FROM `values` WHERE `id` IN (" . implode(',', $ids));

while ($row = $result->fetch_row()) {

$data[] = $row;

}

}

　错误5：内存使用低效和错觉

　　一次sql查询获取多条记录比每次查询获取一条记录效率肯定要高，但如果你使用的是php中的mysql扩展，那么一次获取多条记录就很可能会导致内存溢出。

　　我们可以写代码来实验下（测试环境： 512MB RAM、MySQL、php-cli）：

// connect to mysql

$connection = new mysqli('localhost', 'username', 'password', 'database');

// create table of 400 columns

$query = 'CREATE TABLE `test`(`id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT';

for ($col = 0; $col < 400; $col++) {

$query .= ", `col$col` CHAR(10) NOT NULL";

}

$query .= ');';

$connection->query($query);

// write 2 million rows

for ($row = 0; $row < 2000000; $row++) {

$query = "INSERT INTO `test` VALUES ($row";

for ($col = 0; $col < 400; $col++) {

$query .= ', ' . mt_rand(1000000000, 9999999999);

}

$query .= ')';

$connection->query($query);

}

　　现在来看看资源消耗：

// connect to mysql

$connection = new mysqli('localhost', 'username', 'password', 'database');

echo "Before: " . memory_get_peak_usage() . "\n";

$res = $connection->query('SELECT `x`,`y` FROM `test` LIMIT 1');

echo "Limit 1: " . memory_get_peak_usage() . "\n";

$res = $connection->query('SELECT `x`,`y` FROM `test` LIMIT 10000');

echo "Limit 10000: " . memory_get_peak_usage() . "\n";

　　输出结果如下：

Before: 224704

Limit 1: 224704

Limit 10000: 224704

　　根据内存使用量来看，貌似一切正常。为了更加确定，试着一次获取100000条记录，结果程序得到如下输出：

PHP Warning: mysqli::query(): (HY000/2013):

Lost connection to MySQL server during query in /root/test.php on line 11

　　这是怎么回事呢？

　　问题出在php的mysql模块的工作方式，mysql模块实际上就是libmysqlclient的一个代理。在查询获取多条记录的同时，这些记录会直接 保存在内存中。由于这块内存不属于php的内存模块所管理，所以我们调用memory_get_peak_usage()函数所获得的值并非真实使用内存 值，于是便出现了上面的问题。

　　我们可以使用mysqlnd来代替mysql，mysqlnd编译为php自身扩展，其内存使用由php内存管理模块所控制。如果我们用mysqlnd来实现上面的代码，则会更加真实的反应内存使用情况：

Before: 232048

Limit 1: 324952

Limit 10000: 32572912

　　更加糟糕的是，根据php的官方文档，mysql扩展存储查询数据使用的内存是mysqlnd的两倍，因此原来的代码使用的内存是上面显示的两倍左右。

　　为了避免此类问题，可以考虑分几次完成查询，减小单次查询数据量：

$totalNumberToFetch = 10000;

$portionSize = 100;

for ($i = 0; $i <= ceil($totalNumberToFetch / $portionSize); $i++) {

$limitFrom = $portionSize * $i;

$res = $connection->query(

"SELECT `x`,`y` FROM `test` LIMIT $limitFrom, $portionSize");

}

　　联系上面提到的错误4可以看出，在实际的编码过程中，要做到一种平衡，才能既满足功能要求，又能保证性能。

　错误6：忽略Unicode/UTF-8问题

　　php编程中，在处理非ascii字符时，会遇到一些问题，要很小心的去对待，要不然就会错误遍地。举个简单的例子，strlen(name)，如果name包含非ascii字符，那结果就有些出乎意料。在此给出一些建议，尽量避免此类问题：

如果你对unicode和utf-8不是很了解，那么你至少应该了解一些基础。推荐阅读这篇文章。
最好使用mb_*函数来处理字符串，避免使用老的字符串处理函数。这里要确保PHP的“multibyte”扩展已开启。
数据库和表最好使用unicode编码。
知道jason_code()函数会转换非ascii字符，但serialize()函数不会。
php代码源文件最好使用不含bom的utf-8格式。
　　在此推荐一篇文章，更详细的介绍了此类问题： UTF-8 Primer for PHP and MySQL

　错误7：假定$_POST总是包含POST数据

　　PHP中的$_POST并非总是包含表单POST提交过来的数据。假设我们通过 jQuery.ajax() 方法向服务器发送了POST请求：

// js

$.ajax({

url: 'http://my.site/some/path',

method: 'post',

data: JSON.stringify({a: 'a', b: 'b'}),

contentType: 'application/json'

});

　　注意代码中的 contentType: ‘application/json' ，我们是以json数据格式来发送的数据。在服务端，我们仅输出$_POST数组：

// php

var_dump($_POST);

　　你会很惊奇的发现，结果是下面所示：

array(0) { }

　　为什么是这样的结果呢？我们的json数据 {a: ‘a', b: ‘b'} 哪去了呢？

　　答案就是PHP仅仅解析Content-Type为 application/x-www-form-urlencoded 或 multipart/form-data的Http请求。之所以这样是因为历史原因，PHP最初实现$_POST时，最流行的就是上面两种类型。因此虽说现在有些类型（比如application/json）很流行，但PHP中还是没有去实现自动处理。

　　因为POST是全局变量，所以更改_POST会全局有效。因此对于Content-Type为 application/json 的请求，我们需要手工去解析json数据，然后修改$_POST变量。

// php

$_POST = json_decode(file_get_contents('php://input'), true);

　　此时，我们再去输出$_POST变量，则会得到我们期望的输出：

array(2) { ["a"]=> string(1) "a" ["b"]=> string(1) "b" }

　错误8：认为PHP支持字符数据类型

　　看看下面的代码，猜测下会输出什么：

for ($c = 'a'; $c <= 'z'; $c++) {

echo $c . "\n";

}

　　如果你的回答是输出'a'到'z'，那么你会惊奇的发现你的回答是错误的。

　　不错，上面的代码的确会输出'a'到'z'，但除此之外，还会输出'aa'到'yz'。我们来分析下为什么会是这样的结果。

　　在PHP中不存在char数据类型，只有string类型。明白这点，那么对'z'进行递增操作，结果则为'aa'。对于字符串比较大小，学过C的应该都知道，'aa'是小于'z'的。这也就解释了为何会有上面的输出结果。

　　如果我们想输出'a'到'z'，下面的实现是一种不错的办法：

for ($i = ord('a'); $i <= ord('z'); $i++) {

echo chr($i) . "\n";

}

　　或者这样也是OK的：

$letters = range('a', 'z');

for ($i = 0; $i < count($letters); $i++) {

echo $letters[$i] . "\n";

}

　错误9：忽略编码标准

　　虽说忽略编码标准不会导致错误或是bug，但遵循一定的编码标准还是很重要的。

　　没有统一的编码标准会使你的项目出现很多问题。最明显的就是你的项目代码不具有一致性。更坏的地方在于，你的代码将更加难以调试、扩展和维护。这也就意味着你的团队效率会降低，包括做一些很多无意义的劳动。

　　对于PHP开发者来说，是比较幸运的。因为有PHP编码标准推荐（PSR），由下面5个部分组成：

PSR-0：自动加载标准
PSR-1：基本编码标准
PSR-2：编码风格指南
PSR-3：日志接口标准
PSR-4：自动加载
　　PSR最初由PHP社区的几个大的团体所创建并遵循。Zend, Drupal, Symfony, Joomla及其它的平台都为此标准做过贡献并遵循这个标准。即使是PEAR，早些年也想让自己成为一个标准，但现在也加入了PSR阵营。

　　在某些情况下，使用什么编码标准是无关紧要的，只要你使用一种编码风格并一直坚持使用即可。但是遵循PSR标准不失为一个好办法，除非你有什么特殊的原因要 自己弄一套。现在越来越多的项目都开始使用PSR，大部分的PHP开发者也在使用PSR，因此使用PSR会让新加入你团队的成员更快的熟悉项目，写代码时 也会更加舒适。

　错误10：错误使用empty()函数

　　一些PHP开发人员喜欢用empty()函数去对变量或表达式做布尔判断，但在某些情况下会让人很困惑。

　　首先我们来看看PHP中的数组Array和数组对象ArrayObject。看上去好像没什么区别，都是一样的。真的这样吗？

// PHP 5.0 or later:

$array = [];

var_dump(empty($array)); // outputs bool(true)

$array = new ArrayObject();

var_dump(empty($array)); // outputs bool(false)

// why don't these both produce the same output?

　　让事情变得更复杂些，看看下面的代码：

// Prior to PHP 5.0:

$array = [];

var_dump(empty($array)); // outputs bool(false)

$array = new ArrayObject();

var_dump(empty($array)); // outputs bool(false)

　　很不幸的是，上面这种方法很受欢迎。例如，在Zend Framework 2中，Zend\Db\TableGateway 在 TableGateway::select() 结果集上调用 current() 方法返回数据集时就是这么干的。开发人员很容易就会踩到这个坑。

　　为了避免这些问题，检查一个数组是否为空最后的办法是用 count() 函数：

// Note that this work in ALL versions of PHP (both pre and post 5.0):

$array = [];

var_dump(count($array)); // outputs int(0)

$array = new ArrayObject();

var_dump(count($array)); // outputs int(0)

　　在这顺便提一下，因为PHP中会将数值0认为是布尔值false，因此 count() 函数可以直接用在 if 条件语句的条件判断中来判断数组是否为空。另外，count() 函数对于数组来说复杂度为O(1)，因此用 count() 函数是一个明智的选择。

　　再来看一个用 empty() 函数很危险的例子。当在魔术方法 __get() 中结合使用 empty() 函数时，也是很危险的。我们来定义两个类，每个类都有一个 test 属性。

　　首先我们定义 Regular 类，有一个 test 属性：

class Regular

{

public $test = 'value';

}

　　然后我们定义 Magic 类，并用 __get() 魔术方法来访问它的 test 属性：

class Magic

{

private $values = ['test' => 'value'];

public function __get($key)

{

if (isset($this->values[$key])) {

return $this->values[$key];

}

}

}

　　好了。我们现在来看看访问各个类的 test 属性会发生什么：

$regular = new Regular();

var_dump($regular->test); // outputs string(4) "value"

$magic = new Magic();

var_dump($magic->test); // outputs string(4) "value"

　　到目前为止，都还是正常的，没有让我们感到迷糊。

　　但在 test 属性上使用 empty() 函数会怎么样呢？

var_dump(empty($regular->test)); // outputs bool(false)

var_dump(empty($magic->test)); // outputs bool(true)

　　结果是不是很意外？

　　很不幸的是，如果一个类使用魔法 __get() 函数来访问类属性的值，没有简单的方法来检查属性值是否为空或是不存在。在类作用域外，你只能检查是否返回 null 值，但这并不一定意味着没有设置相应的键，因为键值可以被设置为 null 。

　　相比之下，如果我们访问 Regular 类的一个不存在的属性，则会得到一个类似下面的Notice消息：

Notice: Undefined property: Regular::$nonExistantTest in /path/to/test.php on line 10

Call Stack:

0.0012 234704 1. {main}() /path/to/test.php:0

　　因此，对于 empty() 函数，我们要小心的使用，要不然的话就会结果出乎意料，甚至潜在的误导你。