phpBB 编码标准规范

 更新时间:2016年11月25日 16:08  点击:2096
以前发过,今天又校对了一下,也当是自己又重新温习了一遍,又有新的感觉。
不愧是久负盛名的开源项目,编码规范简单精练,切中要害。
希望能对大家有所帮助,欢迎交流看法。 

phpBB 编码标准规范

如果您对原手册内容有注解或建议,请发电子邮件至 nate@phpbb.com ;
如果您对本文翻译有什么意见或建议,请联系QQ78045595,或发电子邮件至gaogan at gmail dot com.

编辑器设定

制表符 vs 空格:为了此事尽可能地简单,我们使用制表符,不用空格。 你可以随便设定编辑器使用多少空格显示制表符,但是必须保证当你保存文件时,它保存的是制表符而不是空格。 这样,我们每个人都可以让代码以我们喜欢的方式显示,同时不破坏实际文件的布局。

换行: 确保编辑器将文件保存为 Unix 格式。这意味着以换行符终止一行,而不是在 Win32 里那样用一个 CR/LF 对,也不是 Mac 所用的某种方式。任何规范的 Win32 编辑器应该做到这点,但这并不见得总是默认的。你需要熟悉你的编辑器。如果你需要有关使用 Windows 文本编辑器的建议,应该去咨询它的开发者。他们中有些人在 Win32 中做编辑工作。

命名约定

在我们的命名约定中,不会使用任何形式的匈牙利命名。我们很多人相信,匈牙利命名是导致代码混乱的一种主要手法。

变量名称:变量名应当全部小写,并且词语之间以单个下划线分隔。

例如: $current_user 是正确的, 但是 $currentuser 和 $currentUser 就不正确。

名称应当是描述性的,并且简明。我们自然不希望使用冗长的句子作为变量名,但是多输入几个字符总好于疑惑于某个变量到底是干什么用的。

循环计数器:允许使用一个单字符变量名的唯一情形是当它作为一个循环计数器的时候。在这种情况下,外层循环的计数器应当始终是 $i。如果有一个循环处于这个循环的内部,它的计数器应当是 $j,进而是 $k,等等。如果循环的计数器是一个已经存在并且名字有意义的变量,本规范并不适用。

例如:
 

1    for ($i = 0; $i < $outer_size; $i++)  
2    { 
3       for ($j = 0; $j < $inner_size; $j++)  
4       { 
5          foo($i, $j); 
6       } 
7    }
    view plain | print | copy to clipboard | ?

 


函数名称: 函数也应该描述性地命名。这里我们并非在用 C 编程,我们不希望写出诸如“stristr()”此类的函数来。同上,使用单词间用单下划线分隔的小写名称。函数名称中某处最好有一个动词。较好的函数名 称如print_login_status(), get_user_data(),等等。

函数参数:参数遵循和变量名字相同的约定。我们不希望一堆这样的函数:do_stuff($a, $b, $c)。在大部分情况下,我们希望仅仅看看函数的声明,就知道怎样使用它。

总结: 这里的基本哲学是不要为了偷懒而伤害了代码的清晰。但是,必须由一些常识来掌握这种平衡;例如, print_login_status_for_a_given_user() 做得就过火了——这个函数命名为 print_user_login_status() 更好些, 或只是 print_login_status()。

代码布局

新建文件的标准头部:这里是一个头部的模版,它应当包含在每个 phpBB 文件开始
 

1    /***************************************************************************
2                   &nb
< 属性:用来描述对象的数据元素称为对象的属性(也称为数据/状态)

在 PHP5 中,属性指在 class  中声明的变量。
在声明变量时,必须使用  public private protected 之一进行修饰,定义变量的访问权限。

Public(公开): 可以自由的在类的内部外部读取、修改。 
Private(私有): 只能在这个当前类的内部读取、修改。 
Protected(受保护):能够在这个类和类的子类中读取和修改。
这里我们先介绍Public(公开)的情况下对属性的读取和修改。

属性的使用:通过引用变量的 -> 符号调用变量指向对象的属性。
在方法内部通过 $this-> 符号调用同一对象的属性。

<?php
class Bike
{
public $color = "blue"; //定义自行车的颜色属性为蓝色
public $price = 200;  //定义自行车的价格为200
}
$myBike = new Bike();  //创建了对象
echo "自行车的颜色为".$myBike->color."<br />";
echo "自行车的价格为".$myBike->price;
?>


输出的结果就应该为

自行车的颜色为blue
自行车的价格为200


以上就是将原先给自行车属性所定义的值进行输出。
接下来是看看怎么在创建对象后修改原来的属性值。

<?php
class Bike
{
public $color = "blue"; //定义自行车的颜色属性为蓝色
public $price = 200;  //定义自行车的价格为200
}
$myBike = new Bike();  //创建了对象
$myBike->color = "red"; //修改成red
$myBike->pirce = 300;  //价格变为300
echo "自行车的颜色为".$myBike->color."<br />";
echo "自行车的价格为".$myBike->price;
?>
 

 

 


<?php
/**
 * @name 采集后的处理.php
 * @date Sat Dec 22 02:07:45 CST 2007
 * @copyright 马永占(MyZ)
 * @author 马永占(MyZ)
 * @link http://blog.111cn.net/mayongzhan/
 */
 
//采集后的文件,然后那来进行处理.这里的东西让我抄了5本书,是哪的不方便提供,自己找找吧.
 
header(''Content-Type:text/html;charset=utf8'');
 
function writer($content,$url)
{
    $fp = fopen($url, ''ab'');
    fwrite($fp, $content);
    fclose($fp);        
}
 
//从1到136页的内容一次合并.这个是最爽的...
 
for ($i=1;$i<136;$i++) {
    $str = file_get_contents(''./myz/''.$i.''.shtml'');
    preg_match("/(<h1>)(.*?)(</h1>)(.*?)(<div class="artibody" id="artibody">)(.*?)(</div>)/s",$str,$arr);
    $arr[6] = preg_replace("/(<span[^>]+>.*?<a[^>]+>)(.*?)(</a></span>)/s","$2",preg_replace("/<p>|</p>/","rn",$arr[6]));
    $result = "rn------------------------------------------------rn------------------------------------------------rn------------------------------------------------rn".$i."----------------马永占的目录编号:".$arr[2]."rn------------------------------------------------rn------------------------------------------------rn------------------------------------------------rn".$arr[6];
    writer($result, "./myz/all.txt");
}
?> 

原理。我在网上找到了一个打包程序make_exe(来自PHPnow)可以把.7z+打包后的文件界面信息打成一个EXE运行包,并在运行自解压后自动运行7z压缩包中的批处理文件。make_exe.zip包里有Make_exe.cmd, PHPServer.sfx,PHPServer.sfx.cf三个文件。看到这一点,大家应该有思路了吧。首先把PHPServer压成 PHPServer.7z文件然后配置好。修改PHPServer.sfx.cf文件,然后运行Make_exe.cmd就可以了。

首先:Make_exe.cmd代码
复制内容到剪贴板
代码:
set v=1.2
copy /b /y PHPServer.sfx + PHPServer.sfx.cf + *.* PHPServer%v%.exe || pause
很明了吧!“set v=1.2”是版本,然后需要三个文件,打包。
PHPServer.sfx.cf代码,打开方法,直接拖到TXT就行了
复制内容到剪贴板
代码:
;!@Install@!UTF-8!
Title="房地产信息管理系统V1.2"
BeginPrompt="# 房地产信息管理系统V1.2安装包 #nn * 确认你没有运行 IIS 等其他占用 80 端口的服务。n * 如果你安装有其他同类套件,请先停止或卸载。n * 安装完成后请不要随便移动安装目录。nn作者:xilo QQ:110026985 主页 http://www.xilo.cn。"
ExtractDialogText="请稍后,正在解压文件 ..."
ExtractTitle="正在解压 ..."
ExtractPathText="请选择解压路经(仅限英文字符):"
ExtractCancelText="取消"
CancelPrompt="你真的要退出吗?"
GUIFlags="4+8+32+64+256+2048"
InstallPath="D:\PHPServer"
RunProgram="cmd /c setup.cmd"
;!@InstallEnd@!
这些我相信也不我解释了,想显示什么就改什么。注意这句InstallPath="D:\PHPServer"为安装目录,还有解压后运行RunProgram="cmd /c setup.cmd"这个BAT,也就是启动apache,mysql服务的命令了。下面就是PHPServer的setup.cmd的命令了。因为太多简单贴上几句!

setup.cmd代码:

代码:

@echo off
rem -- http://www.xilo.cn
rem -- By xilo (QQ:110026985)
setlocal enableextensions
call Pnconfig.cmd
prompt -$g
title 初始化 PHPserver %pnver% - Apache + PHP + MySQL
echo   ____________________________________________________________
echo  ^|                                                            ^|
echo  ^|  ######  正在安装 浩搏不动产信息管理系统 环境套件  ######  ^|
echo  ^|____________________________________________________________^|
echo.

:copy
echo   _____________________________
< PHP的学习

学习使用了阵子PHP,PHP开发速度应该是不错的,相同的项目PHP的代码量估计要比用JSP要少很多。
但是在使用过程中也发现一些问题,也看了一些别人PHP项目代码,说下一下感受.

1. PHP灵活但不能涂鸦一般使用.
如果把数据库操作都写在一个页面上,维护就吃力了.至少要把数据库操作跟页面渲染分离开,类似JSP
加JavaBean的方式,相信这也是PHPer采用的简单MVC.

2.PHP常量
PHP array的array的读写都很灵活,可能页面会经常有这样的
echo $myArray[''myKey''];数据库操作mysql_fetch_array返回的row也是,万一key值''myKey''开发的
时候没定义好,又或''myKey''是列名,突然要改了,这个常量每个文件都有的话,改起代码来就郁闷了.
PHP会使用define,类里面会使用const来代表常量
define(''MY_CONSTANT'', ''MY_VALUE'');
echo MY_CONSTANT;
class MyClass{
    const MY_CONSTANT = ''MY_VALUE'';
    public function test(){
    echo self::MY_CONSTANT;
    }
}
//External usage
echo MyClass::MY_CONSTANT;

3.=号赋值拷贝
=大多情况下是拷贝的形式的赋值.
$oldValue = array(1,2,3);
$newValue = $oldValue;
$newValue[] = 4;
echo $oldValue;//1,2,3
echo $newValue;//1,2,3,4
可以看到$newValue只是值拷贝,它的修改不会改变$oldValue.估计class实例的赋值也是拷贝。

还有什么会导致拷贝,function的入参,和return返回值应该也是默认是值拷贝传递.
function test($param) {
echo $param;//string
$param = ''newstring'';
echo $param;//newstring
}
$strParam = ''string'';
test($strParam);
echo $strParam;//string

foreach迭代array的时候可能导致拷贝
$myArray = array(''key1''=>''value1'',''key2''=>''value2'');
foreach($myArray as $key=>$value) {
    echo "$key=$value<BR/>";
}
按照PHP手册的说法就是foreach的时候是拷贝了一个新的array,即使在循环中修改了值,对旧array没影响.

=号对于clone好像是不算是拷贝?

个人感觉不太喜欢拷贝,如果拷贝的东西比较大,估计会影响执行效率了吧.

4. 使用reference引用避免拷贝
其实就是使用=& 引用其实是别名Alias,觉得这个就是java,c#类默认使用的,PHP必须显式加个&,有点像
c++.
$oldValue = array(1,2,3);
$newValue = &$oldValue;
$newValue[] = 4;
echo $oldValue;//1,2,3,4
echo $newValue;//1,2,3,4

PHP4里面$myClassInstance = new MyClass();其实是一种拷贝, 必须
$myClassInstance = &new MyClass();
PHP5里面就支持好多了默认new出来的东西就是PHP4里面的&new引用。

入参如果数据大(假设是一个大数组)可以传递引用避免值拷贝
function test(&$param) {
echo $param;//string
$param = ''newstring'';
echo $param;//newstring
}
$strParam = ''string'';
test($strParam);
echo $strP
[!--infotagslink--]

相关文章

  • 源码分析系列之json_encode()如何转化一个对象

    这篇文章主要介绍了源码分析系列之json_encode()如何转化一个对象,对json_encode()感兴趣的同学,可以参考下...2021-04-22
  • php中去除文字内容中所有html代码

    PHP去除html、css样式、js格式的方法很多,但发现,它们基本都有一个弊端:空格往往清除不了 经过不断的研究,最终找到了一个理想的去除html包括空格css样式、js 的PHP函数。...2013-08-02
  • index.php怎么打开?如何打开index.php?

    index.php怎么打开?初学者可能不知道如何打开index.php,不会的同学可以参考一下本篇教程 打开编辑:右键->打开方式->经文本方式打开打开运行:首先你要有个支持运行PH...2017-07-06
  • PHP中func_get_args(),func_get_arg(),func_num_args()的区别

    复制代码 代码如下:<?php function jb51(){ print_r(func_get_args()); echo "<br>"; echo func_get_arg(1); echo "<br>"; echo func_num_args(); } jb51("www","j...2013-10-04
  • PHP编程 SSO详细介绍及简单实例

    这篇文章主要介绍了PHP编程 SSO详细介绍及简单实例的相关资料,这里介绍了三种模式跨子域单点登陆、完全跨单点域登陆、站群共享身份认证,需要的朋友可以参考下...2017-01-25
  • PHP实现创建以太坊钱包转账等功能

    这篇文章主要介绍了PHP实现创建以太坊钱包转账等功能,对以太坊感兴趣的同学,可以参考下...2021-04-20
  • php微信公众账号开发之五个坑(二)

    这篇文章主要为大家详细介绍了php微信公众账号开发之五个坑,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2016-10-02
  • ThinkPHP使用心得分享-ThinkPHP + Ajax 实现2级联动下拉菜单

    首先是数据库的设计。分类表叫cate.我做的是分类数据的二级联动,数据需要的字段有:id,name(中文名),pid(父id). 父id的设置: 若数据没有上一级,则父id为0,若有上级,则父id为上一级的id。数据库有内容后,就可以开始写代码,进...2014-05-31
  • PHP如何通过date() 函数格式化显示时间

    这篇文章主要介绍了PHP如何通过date() 函数格式化显示时间,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-11-13
  • c#字符串编码编码(encoding)使用方法示例

    System.Text提供了Encoding的抽象类,这个类提供字符串编码的方法。使Unicode字符数组的字符串,转换为指定编码的字节数组,或者反之,看下面的例子...2020-06-25
  • PHP+jQuery+Ajax实现多图片上传效果

    今天我给大家分享的是在不刷新页面的前提下,使用PHP+jQuery+Ajax实现多图片上传的效果。用户只需要点击选择要上传的图片,然后图片自动上传到服务器上并展示在页面上。...2015-03-15
  • 老生常谈javascript变量的命名规范和注释

    下面小编就为大家带来一篇老生常谈javascript变量的命名规范和注释。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2016-10-02
  • 通过javascript进行UTF-8编码的实现方法

    下面小编就为大家带来一篇通过javascript进行UTF-8编码的实现方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2016-07-01
  • 详解JS ES6编码规范

    本章节讨论使用ES6编码风格到代码中需要注意的点。通过记住这些关键点,可以让我们写出更优美的、可读性更强的JavaScript ES6风格的代码。...2021-05-08
  • golang与php实现计算两个经纬度之间距离的方法

    这篇文章主要介绍了golang与php实现计算两个经纬度之间距离的方法,结合实例形式对比分析了Go语言与php进行经纬度计算的相关数学运算技巧,需要的朋友可以参考下...2016-07-29
  • PHP如何使用cURL实现Get和Post请求

    这篇文章主要介绍了PHP如何使用cURL实现Get和Post请求,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-11
  • php中把unicode编码转化为中文

    小编在网上看到最多的就是汉字转换unicode编码了,今天我们看到一个反过来的操作就是把unicode转换成中文了,下面一起来看看 这两天帮别人开发微信平台好友板块,存...2016-11-25
  • thinkPHP中多维数组的遍历方法

    这篇文章主要介绍了thinkPHP中多维数组的遍历方法,以简单实例形式分析了thinkPHP中foreach语句的使用技巧,需要的朋友可以参考下...2016-01-12
  • PHP正则表达式过滤html标签属性(DEMO)

    这篇文章主要介绍了PHP正则表达式过滤html标签属性的相关内容,实用性非常,感兴趣的朋友参考下吧...2016-05-06
  • .Net(c#)汉字和Unicode编码互相转换实例

    下面小编就为大家带来一篇.Net(c#)汉字和Unicode编码互相转换实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25