kakapo's nest

KFC应用开发规范(3)_视图模板开发

Fri, 10 Aug 2007 10:09:17 +0000

原理: 引入模板引擎类，根据其语法规范，将网页制作成模板文件。

规范：
1. 一套模板风格以一个目录名放在View目录下;
2. 模板名称组成: 控制器名_功能名.html 例如user_closet.html

注意事项：
1.模板的开发规范根据不用模板引擎而不同。
2.KFC会将一些全局变量自动赋值到模板文件中以供使用,这些全局变量为：网站基本信息 $GLOBALS['gSiteInfo']和语言包$GLOBALS['gLang']

范例：

使用phpTemplate引擎的模板:

header.html文件

<?=$site_name?>

其他文件

用户名：

昵　　称：

性　　别：

地　　区：

保密邮箱：

Tags - kfc , 开发规范

KFC应用开发规范(2)_业务模型开发

Fri, 10 Aug 2007 10:07:25 +0000

原理: 分析业务逻辑，抽象出接口，开发底层的业务类，提供给控制层使用。

规范:
1. 模型文件命名为 foo.class.php;
2. 类名跟文件名"."号的最前头一致, class foo{};

API：
resource parent::dbConnect(array $options);

注意事项：
由于数据库操作类有多种选择adodb,peardb,pdo,database，所以开发人员要熟悉这些类的使用方法。

类书写范例

/*
* 需要数据库操作的要继承 Model
*
*/
class UserWealthManage extends Model {
  // php5 的写法
  private $mydb="";

  /**
  * 选择php5 构造函数
  *
  */
  function __construct(){
    $this->mydb = parent::dbConnect($GLOBALS['gDataBase1']);
  }
  /**
  * 或者php4 构造函数，这里只是为了说明KFC框架类库本身兼容php4，php5，
* 但是应用项目最好采用php5的类规范来开发。
  *
  */
  function UserWealthManage(){
    $this->mydb = parent::dbConnect($GLOBALS['gDataBase1']);
  }
  /**
  * 获取用户
  *@params int $user_id
  *@return mixed
  */
  function GetUserWealth($user_id){
    $n=floor($user_id/100000);
    $table = "user_".($n+1)."0w";
    $query = "select * from $table where user_id=".$user_id;
    $user_wealth = $this->mydb->getAll($query);
    if($user_wealth!==false){
      return $user_wealth;
    }else{
      return false;
    }

  }
  /**
  * 解析字符串
  *@params string $str
  *@return array
  */
  function ParseItemStr($str){
    if(!empty($str)){
      if(substr($str,-1,1)==';') $str = substr($str,0,-1);
      $arrs = array();
      $array = array();
      $arrs = explode(";",$str);
      foreach ($arrs as $k=>$v){
        $array[$k] = explode(",",$v);
      }
      unset($arrs);
      return $array;
    }
  }

function __destruct(){
unset($this->mydb);
}

}

?>

轻量级数据库类database.class.php API

//初始化参数
class database($database_type,$host,$database,$user,$password,$port=false,$dsn=false);

//连接数据库
boolen connect(void);

//返回false 或者连接资源
mixed query(string $sql_statement, array $array ='');

// 执行结果
boolen execute(string $sql_statement, array $array ='')

//返回根据从结果集取得的行生成的数组，如果没有更多行则返回 FALSE。
mixed fetchRow(resource $result)

//只返回一行
mixed getRow(resource $result);

// 取得结果集中行的数目
mixed countRows(resource result);

// 取得所有数据
array getAll(string $sql_statement, array $array ='');

// 应用举例
$db = new database($options['type'],$options['host'],$options['dbname'],$options['user'],
    $options['passwd'],$options['port']);

// 获取结果
$result = $db->query("select * from user where user_id=?", array($user_id));
while($row = $db->fetchRow($result)){
  $array[] = $row;
}

// 取得行数
$num = $db->countRow($result);

// 执行操作
$r = $db->execute("update user set user_name='ddd' where user_id='{$user_id}'");
if($r){
  return true;
else
return false;

// 取得一行
$row = $db->getRow("select * from user where user_id=?", array($user_id));

// 取得所有
$array = $db->getAll("select * from user where 1");

?>

Tags - kfc , 开发规范

KFC应用开发规范(1)_控制器开发

Fri, 10 Aug 2007 09:57:47 +0000

原理：利用面向对象的思维，将功能点定义为类的方法；将应用功能模块定义为一个类；

规范：
1. 控制器文件命名为 foo.class.php;
2. 类名跟文件名"."号的最前头一致，class foo{}；
3. 类的方法命名采用"view_"或者"op_" 小写开头; 剩下功能描述部分(功能名)只能为大小写字母和数字组成，如view_home1 , op_saveForm
*不带view_和op_ 开头的类方法不会做为应用项目系统的权限点；

API 接口：
// 权限验证
void parent::authenticate();

// 引入业务模型
object $this->includeModel(string $model_name);

// 引入外部组件
object $this->addComponent($com_name);

// 赋值到模板，跟smarty一样
void $this->assign('var',$value);

// 显示模板
void $this->display($tpl_name);

// 显示提示信息
void show_message(string $message);

// 返回
void goback();

// 跳转到其他页面
void Redirect(string $url,int $type);

类书写范例

class foo extends Controller{

/**
* _constructor KFC自带的仿构造函数，会在类实例化时自动执行
* @access public
* @return void
*/
function _constructor(){
// 权限验证
parent::authenticate();
}
/**
* URL访问：?action=foo&view=home&var=1111
* @access public
* @return void
*/

function view_home(){

// 初始化外部变量
$var = isset($_GET['var'])?$_GET['var']:'';

// 引入业务模型
$userManage = $this->includeModel("UserManage");
$userinfo = $userManage->getUserInfo(22);

// 引入外部组件
$phpmailer = $this->addComponent('phpmailer');

// 赋值到模板，跟smarty一样
$this->assign("var",$var);
// 显示模板
$this->display("foo_home.html");
}
/**
* 处理POST提交的操作：在form表单需要插入
*
*
* @access public
* @return void
*/
function op_saveForm(){
// $KFC_POST 获取了$_POST的所有数据；
global $KFC_POST;

print_r($KFC_POST);

//....
// 实际业务编程

// 完成后需要跳转几个内置函数可以参考使用

// 显示提示信息
show_message("操作成功！");
// 返回
goback();
// 相当于 show_message_goback("操作成功！");

//或者跳转到其他页面
//类型1 使用php的header;类型2 使用js的location.href;类型3 使用setTimeout跳转;
Redirect("http://www.google.cn",1);

}

function otherFunction(){

// 编程

return ;
}

}
?>

Tags - kfc , 开发规范

创建Hello World.

Wed, 13 Jun 2007 03:02:27 +0000

在用KFC的自动安装程序启动了项目之后，在根目录下会出现应用项目名称，控制器目录Controllers下有一个默认文件defaults.class.php，里面有hello world举例存在。本文要描述的是如何手动启动KFC的应用项目。

第一步：在网站根目录下，首先将整个KFC框架拷贝过来，然后分别创建目录Controllers(控制器)，Models(业务模型)，Views(模板视图)，tmp(缓存目录)，Languages(语言包目录)，public(公共目录)，Plugins(外部插件目录)。
在public目录下再分别创建目录flashs,images,javascripts,stylesheets,htmls，这些目录将存放全站共享的静态文件。

第二步：创建配置文件config.ini.php,代码如下：

//Application

//use dev, online
define("APP_STATUS", 'dev');

// define application directory
define("APP_DIR", dirname(__file__));

// define systems KFC directory, it can be relative
define('KFC_DIR', APP_DIR . "/KFC");

// define language
define("APP_LANG",'en');

// use database or not
define("USE_DATABASE",0);

// define session save handle (file, mysql, memcache)
define("SESSION_HANDLE",'file');

// turns off access to post variables through anything
define('HIDE_POST', 1);
// disallow spaces in url parameters, helps prevent sql injection.
define('STRIP_URL_VARS' ,1);

//Global-Site Settings
$GLOBALS['gSiteInfo']['site_name'] = 'KFC Demo';
$GLOBALS['gSiteInfo']['version'] = 'v1.0';
$GLOBALS['gSiteInfo']['site_url'] = 'http://localhost/';
$GLOBALS['gSiteInfo']['site_title'] = "KFC PHP Framework";
$GLOBALS['gSiteInfo']['webcharset'] = 'utf-8';
$GLOBALS['gSiteInfo']['pagenum'] = 15;

?>

第三步：创建一个入口文件index.php，代码如下：

include(dirname(__file__) . "/config.ini.php");
include(KFC_DIR . "/KFC.php");
$start_time = getmicrotime();

// new application
$kfc = &new KFC(APP_DIR,0);

// set defaults controller (option)
$kfc->setDefController('defaults');

// set default view style
$kfc->setDefView('defaults');

$kfc->run();

$end_time = getmicrotime();
echo "执行时间: ".($end_time-$start_time)."";
?>

第四步：在Controllers下面创建一个目录index(必须跟入口文件名称一致)，然后在index目录下创建一个默认控制器文件defaults.class.php,代码如下：

class defaults extends Controller{

function view_defaults(){

//example use tpl
$assign['homepage']['name'] = "Hello World!";

$this->assign($assign);
$this->display("index.html");

}

}
?>

第五步：在Views目录下创建defaults目录，做为默认主题模板。然后在defaults目录下创建模板index.html
代码如下：

<?=$site_title?>

第六步：完成，在浏览器输入http://localhost/index.php
Tags - kfc

KFC中文手册整理

Thu, 08 Mar 2007 07:35:54 +0000

第一章. 简介和缘起

第二章. 基本思想

第三章. KFC执行流程图

第四章. 目录结构和文件

第五章. 安装和配置

第六章. 创建Hello World.

第七章. 业务模型开发

第八章. 缓存的使用

第九章. 权限模块

第十章. 组件的扩展

Tags - kfc

安装和配置

Thu, 08 Mar 2007 07:21:09 +0000

KFC因为提供了安装程序，使启动一个应用项目变得非常简单。KFC框架本身不用安装。

安装：
1. 下载源文件压缩包，上传至网站空间，解压缩后出现KFC、admin、install、Docs和install.php等，admin为示例应用项目(demo)；
2. 运行install.php，按照提示操作自动创建新的应用项目(需要保证根目录权限为777）。否则手动按照示例项目先创建应用项目目录，然后逐步创建其他目录和入口文件，配置文件等。
3. 将web服务器documentroot目录修改指到项目目录下。(使用虚拟主机空间的用户只需要在步骤2选择在根目录下安装项目，步骤3就不用做了)。

配置：
应用项目安装完成之后，程序员可以修改的配置地方只有两个文件，入口文件和配置文件。一般情况下，入口文件在确定了默认启动控制器，默认模板风格，数据库引擎类，模板引擎类，是否启动权限验证，是否采用缓存之后就不需要修改了。剩下可以修改的配置全在config.ini.php。除了安装时KFC框架必需的静态配置之外，程序员还可以根据项目要求增加配置参数。
Tags - kfc

KFC执行流程图

Thu, 08 Mar 2007 07:05:01 +0000

KFC系统的执行过程如下图所示：

Tags - kfc

目录结构和文件

Sat, 09 Dec 2006 07:19:43 +0000

KFC目录结构图

Common 目录存放config.php基本配置，error.php错误处理工具，globals.php全局定义，utils.php常用工具。
Components 目录存放外部精选的组件，libs/ 目录放着组件源代码。
Core 目录存放核心组件。

KFC框架的核心文件叫KFC.php，这个文件要解决的问题有下面几个：
1、引入框架全局文件，包含静态变量，全局变量，内置常用方法，错误处理方法等。
2、设置应用系统路径、启动控制器、启动必需组件及注册session所需变量；
3、采用URL mapping (URL 镜像)机制，让程序员能很方便的找到网页执行程序的位置。简单的说是，一个方法处理一个网页，一个控制类是一些处理相关网页的方法的集合。

举例：

http://localhots/index.php?action=user&view=login
其中user指向控制器Controllers目录下用户控制器类文件user.php里的类Class user{}，login指向Class user{}的一个方法$user::login()。
action表示将要启用的控制器；view表示这是一个GET方式，需要一个模板；而POST方式将由变量op来表示，一般情况下POST方法不需要模板

示例应用系统admin的目录结构图：

Models 目录存放应用系统的数据业务模型，一般为的业务处理类。
Views 目录存放着模板文件；
Controllers 目录存放控制器文件，这些文件分别归类在以入口文件名命名的目录下，每个文件是处理相关网页集合的类，都要继承KFC框架的核心类Class Controller{}，以获得调用组件的方法。
Languages 目录存放语言包文件；
Plugins 目录存放一些此项目所需的其他插件，KFC框架没有的；需要使用时由程序员自己引入。
public 目录将存放images，flash，javascripts，css，html等静态文件。
tmp 是一个缓存目录，需要定义为777，具有可写入可操作。比如存放smarty的编译文件等。
config.ini.php 是应用系统的基本配置文件；
admin.php 应用系统的一个入口，负责引入KFC.php文件并执行页面程序。
.htaccess 为apache的权限控制文件，常用来配置url_rewrite规则。

Tags - kfc

基本思想

Mon, 04 Dec 2006 15:39:00 +0000

组件的选择和准备
一般成熟稳定的工具类不只有一个类，而是多个类的有机组合，它能够完美体现程序设计方法，特别是面向对象开发的思维精华。每个工具类都有自己特定的应用范畴，譬如phpmailer就专门为了发送邮件的。而且这种工具类一般都有使用demo，甚至还有用户使用手册(end- user document). 比如adodb,smarty。它们也经常有升级版本，不断的debug。具有以上特征的类可以定义为成熟优秀的工具类。

在KFC框架里面，每个这样的工具类都被放在Components/libs库中，分别独立存放自己的目录里，方便以后升级覆盖。然后，通过一个Class Component{}抽象出它们共有的属性和方法。于是每个工具类就被KFC当作了一个个组件，分别用 Class component_toolname{} 继承并扩展父类Class Component{}，具体实现本组件的细节部分，完成本组件的实例化，随时准备好被应用系统调用。以后扩展组件库，每引进一个成熟的php工具类，都如法炮制。

组件的调用和搭配
组件的调用是由控制器类来完成的。命名为Class Controller{}，同时这个类还要有调用业务模型Model接口，视图View接口。

首先，KFC将所有组件分为必需的和可选的两种类型，避免了执行时间的浪费。必需的组件必须在应用系统初始化的时候就被默认调用，可选的组件在编程过程中根据实际事务灵活调用。通常来说必需的组件有数据库封装类，模板引擎类，Session管理类等等。国外的Zoop框架就要求所需组件都必须在初始化时调用，但是在应用系统中并不是每个执行页面都会用上所有组件，造成了执行效率降低。

其次，必需组件的选用决定了应用系统的开发效率和执行速度。通过必需组件的灵活搭配，可以适应不同的应用需求。例如后台开发可以使用peardb ＋smarty，强大的smarty可以帮助提高编程速度。前台开发用adodb＋phptemplate，利用adodb实现数据对象的缓存。小型前台(如企业网站)如果为了追求轻便快速，可以采用超轻量级的database+phptemplate；

关于控制器
Class Controller{}核心文件需要被应用系统的控制器类继承，因为它提供了灵活调用可选组件的方法。同时也负责了应用系统启动需要的基本环境搭建工作。比如调用语言包和引入应用系统全局配置。

Tags - kfc

简介和缘起

Thu, 30 Nov 2006 15:09:43 +0000

KFC, 全称是Kindly Fast Component (友好性、快速性、组件化)，是一个php开发框架。核心思想是友好引入现有的优秀的php工具类，将其作为框架可选的组件。不断开发自己的内置的核心的组件。在按需调用的原则下，通过组件的优化搭配实现快速的执行效率。以MVC模式开发，以面向对象思想编程。兼容php4与php5。

研究了不少php开发框架，其中有些是重新构建自己的基础工具类，比如数据库抽象类，模板引擎类。虽然这些框架的作者本着快速的想法重新开发这样的工具类为自己的框架所用，但是，这造成大量的功能相同使用方法不同的工具类出现，同质化现象严重，给新手造成选择和使用的麻烦。比如国外的CakePHP和国内的ThinkPHP。想使用这些框架的phper都要重新学习熟悉这些常用工具的使用方法。其实，php数据库抽象类开发的最成熟的当数adodb以及peardb。当我开始减少使用mysql_connect()后，就开始学习并熟练掌握peardb、adodb，后者更强大。

还有，在模板引擎类方面，最强大的当数php官方发布的Smarty。但是一些人认为smarty太庞大太复杂而放弃它，认为学习smary像在重新学习一门语言，转而去选用其他小巧灵活的模板引擎，像FastTemplate或者SmartTemplate。如果他们没有真正了解smarty就放弃了它的话，我认为这是一种放弃了西瓜而去捡芝麻的做法。

开发框架基本上离不开数据库抽象类和模板引擎类。我相信不少phper也会有自己常用的这两种工具类，甚至还掌握了更多的成熟的优秀的工具类。比如发布邮件的phpmailer，操作xml的domit，创建rss的Feedcreator等等。还有pear库里面更多的类等待探索。既然有这么多优秀的工具类存在，而且有持续的升级版本出现，为什么不借鉴来使用呢？所以KFC提倡“拿来主义”，取其精华，为我所用。

Tags - kfc