您的位置:首页 > 其它

中文 PFC 1.0 手册(转)

2006-05-15 15:26 363 查看
类似于phplib,但这是中国人自已开发的,仔细研究下,能学到不少东西。

中文 PFC 1.0 手册
1,中文PFC简介
2,中文PFC目的
3,PFC目标
4,PFC宗旨
5,编程风格
6,如何为PFC添加工具
7,如何写一个工具类
8,如何测试PFC工具
9,PFC内置公共类使用手册
10,PFC简易框架
11,下载
12,安装
13,PFC工具使用方法

=================
中文PFC 简介
=================
PFC 是针对中文用户的一套PHP 5开发工具系统。它的全名为PHP Foundation Classes。只所以针对中文用户,是为了能在国人辛勤,努力,智慧,创新的基础上开发出中国人自己的能与世界水平媲美的一批类库来,并倡导标准化,国际化,专业化,高层次的开发。同时也希望能开发出很多方便实际应用的工具来。总得来说,PFC 1.0 是以提供方便,快捷,标准,多样化的工具为最终目标。

=================
中文PFC目的
=================
1,提供最基本的类库
2,提供大量的工具用以快速,方便,高效的创建系统
3,提供OOP开发解决方案(开发框架)
4,提供ADODB,smarty,JGraph等类库统一风格的接口
5,制订统一的PHP与模板,数据库,HTML开发的标准

=================
PFC 目标
=================
1,提供稳定的,实用的,可扩展的,多功能的,强大的类库及工具箱
2,可行的,广为认可遵循的的PHP开发标准
3,中文的,完善的,高水平的,与国际并行的开发体系
4,有专门的中文PFC站点,电子书籍,甚至纸张印刷书籍

=================
PFC 宗旨
=================
开源,开放,自由,创新

=================
编程风格
=================
1,采用接近JAVA的命名方式,比如方法名第一个单词小写,其它单词大写;比如类名称第一个字母大写;比如文件名和类名称一致。
2,采用PHPDOC注释风格:@param 指参数,@version指版本,@return指返回等等。
3,方法或函数应用的参数前以空格相隔:比如 a(1, 2, 3),可以看到2和3前面都有个空格。
4,花括号采用对称方式。比如:
function a()
{

}
5,函数名和方法名严格遵守大小写。
6,各变量,常量,方法,函数,类名称均要求近可能通用化,比如Request,Response,Calendar等等。
7,目录和文件名的组合中的每个单词首字母大写,比如UtilPackage。

=================
如何为PFC添加工具
=================
1,下载PFC 1.0
2,将你写好的工具主文件用 工具名 + Tool + .php 命名,比如工具为test,那么就命名为TestTool.php,类的写法看“如何写一个工具类”部分,然后将所有文件放入到pfc/Tools/目录下。
3,进行测试,参数“如何测试PFC工具”部分。
4,测试无误后,就可以通过 email: iwind_php@163.com QQ:38396104 联系我 (工作时间可能没有时间处理,请见谅),我们会尽快做一个维护平台。
5,审核通过后,我会把它放到网站上供大家下载使用

=================
如何写一个工具类
=================
1,一个工具应该提供一个供调用的主类,该主类提供一些供调用的接口。
2,类的名称和文件名一致,比如TestTool.php里放TestTool类;而CalendarTool.php里放的是CalendarTool类。
3,类构造函数可以有0到多个参数。
4,类规则应该遵循PFC 1.0 编程风格。
5,类最好能提供version()方法,以供方便的获取版本号。

=================
如何测试PFC工具
=================
PFC 1.0Pfc::getTool()来获取工具的实例,从而来实现一些功能。

现在以Test工具为例,我事先写好了一个供测试的工具,名为Test,所以类名称为TestTool,文件在pfc/Tools/TestTool.php,程序为:
<?php
class TestTool extends Util
{
private $version = "Test 1.0";

function __construct($arg1, $arg2)
{
echo "this is constructor:arg1-{$arg1};arg2-{$arg2}<br />";
}

public function test()
{
echo "this is is a test.<br />";
}

public function version()
{
return $this->version;
}
}
?>


下面我就将在pfc同级目录下建立一个测试文件,名为index.php,内容如下:

<?php
//包含进PFC主文件
require "pfc/Pfc.php";

//用 getTool 方法 获得工具
//getTool的第一个参数是要调用的工具名称,又由于TestTool类的构造器有两个参数,所以我定义了第二个,第三个参数(一共两个参数,否则会出错)
$test = Pfc::getTool("Test", "参数1", "参数2");

//调用Test工具的一个方法
$test->test();
?>


运行后,就可以看到输出
this is constructor:arg1-参数1;arg2-参数2
this is is a test.

说明这个工具是运行无误的。

注意:所有工具类都应该继承自Util类。

=================
PFC内置公共类使用手册
=================
点此查看phpDocumentor生成的文档

=================
PFC简易框架
=================
为简化开发,PFC 1.0提供一个最简单的框架。以下是一个例子。

<?php
//包含简易框架类
require "pfc/Application.php";

/**
* 以下写一个处理某种业务的模块
* 类名称和要调用的方法名均以pfc开头
*/
class PfcModule
{
/**
* 构造器
*/
function __construct()
{

}

/**
* 默认执行的动作
*/
public function pfcDefault()
{
echo "I am default.";
}

/**
* action 为 add 的动作
*/
public function pfcAdd()
{
echo "I am add.";
}

/**
* action 为edit的动作
*/
public function pfcEdit()
{
echo "I am edit.";
}
}

$pfcApp->run("module");
?>

即在一个类中为各种动作(或称为事件)写不同的方法,程序就会自动调用。上述例子中,用 文件名?action=add文件名?action=edit 访问,就会分别出现"I am add." 和 "I am edit.".而如果没有action的话,则会出现"I am default.".

如果你不想让标识动作的关键字为"action",可以:
$pfcApp->setKeyword("ac"); // 改变关键字
$pfcApp->run("module");


这样就把关键字改成ac了。用 文件名?ac=add文件名?ac=edit 访问,就可以看到效果。


=================
下载
=================

PFC 1.0 主文件

Test工具下载
简介:用于测试PFC 1.0的工具。

Template工具下载
简介:从PHPLib Template类修改过来的用于模板处理工具类。查看API 查看使用说明

Charset转换工具
简介:目前可以实现以下“字符集”转换:gb <-> big5;gb,big5<->utf-8; gb,big5->unicode;gb->pinyin;unicode->utf-8 查看使用说明

SeekFile工具
用于查找定长数据中的某一条目的类。 查看使用说明

Timer 计时工具
用来计算程序运行时间的类。 查看使用说明

Pager 分页工具
用来实现分页页码的显示。目前只给出了几个简单的示例性质的分页样式。查看使用说明

代码高亮工具
用来高亮代码,目前只支持[php][/php],[html][/html],[java][/java],[javascript][/javascript],[vbscript][/vbscript],[css][/css]等几种代码的简单高亮. 查看使用说明

=================
安装
=================
1,下载 PFC 主文件.
2,解压出pfc目录,放到网站任意目录下.
完成以上两步后,你就可以使用 PFC 内置对象和方法了.同时也可以使用PFC简易框架

---------------
3,如果你想使用我们已有的工具,可以先下载工具,然后将该工具所包含的所有文件都放入到pfc/Tools/目录下。然后就可以使用这个工具了,请参考这里

=================
PFC工具使用方法
=================
1,安装PFC
2,第一步同 "如何测试PFC工具"
3,得到的$test就是工具的一个实例对象,就可以用它进行操作了Test工具的所有可用的方法和属性了。至于某种工具的使用,具体要看这个工具的说明或文档。

内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: