PHP Smarty程序应用范例

<?php/*** project: guestbook sample smarty application* author: monte ohrt <monte [at] ohrt [dot] com>* date: march 14th, 2005* file: index.php* version: 1.0*/// define our application directorydefine('guestbook_dir', '/web/www.example.com/smarty/guestbook/');// define smarty lib directorydefine('smarty_dir', '/usr/local/lib/php/smarty/');// include the setup scriptinclude(guestbook_dir . 'libs/guestbook_setup.php');// create guestbook object$guestbook =& new guestbook;// set the current action$_action = isset($_request['action']) ? $_r
equest['action'] : 'view';switch($_action) {    case 'add':        // adding a guestbook entry        $guestbook->displayform();        break;    case 'submit':        // submitting a guestbook entry        $guestbook->mungeformdata($_post);        if($guestbook->isvalidform($_post)) {            $guestbook->addentry($_post);            $guestbook->displaybook($guestbook->getentries());        } else {            $guestbook->displayform($_post);        }        break;    case 'view':    default:        // viewing the guestbook        $guestbook->displaybook($guestbook->getentries());                break;   }?>

“index.php”扮演着整个程序的控制者这个角色。它掌控着所有来自web浏览器的访问请求，并指导程序发生些什么相应的动作。它定义了程序目录，包括程序的安装脚本，以及根据全局变量$_request所定义的action值，并指导程序做出相应的动作。

这里有三个基本的动作设置（actions）：

“添加”当用户往留言簿里写内容时；
“提交”当用户写完内容提交时；
“浏览”当用户浏览留言簿时。

缺省情况是“浏览”。

/web/www.example.com/smarty/guestbook/libs/guestbook_setup.php

<?php/*** project: guestbook sample smarty application* author: monte ohrt <monte [at] ohrt [dot] com>* date: march 14th, 2005* file: guestbook_setup.php* version: 1.0*/require(guestbook_dir . 'libs/sql.lib.php');require(guestbook_dir . 'libs/guestbook.lib.php');require(smarty_dir . 'smarty.class.php');require('db.php'); // pear db// database configurationclass guestbook_sql extends sql {    function guestbook_sql() {        // dbtype://user:[email protected]/dbname        $dsn = "mysql://guestbook:[email protected]/guestbook";        $this->connect($dsn);    }       }// smarty configurationclass guestbook_smarty extends smarty {     function guestbook_smarty() {        $this->template_dir = guestbook_dir . 'templates';        $this->compile_dir = guestbook_dir . 'templates_c';        $this->config_dir = guestbook_dir . 'configs';        $this->cache_dir = guestbook_dir . 'cache';    }}      ?>

我们通过“guestbook_setup.php”进行一些基本的程序运行环境设置，比如设置程序的后台数据库和模板文件位置。我们使用pear的pear::db库，请确认能够通过你的php.ini中的“include_path”设置访问“db.php”脚本文件，或者干脆使用“db.php”的绝对路径。我们用mysql作为程序的后台数据库，在这里书写恰当的“dsn”信息以便使用你自己的mysql数据库。

注意：如果运行中你得到一个类似“call to undefined function: query()”样的错误，说明“$dsn”不正确，请检查“$dsn”是否正确，并测试是否数据库已经连接上了。

我们需要安装一个基本的数据库结构。接下来这个命令行脚本会把我们的数据表导入mysql数据库中。
mysql < guestbook.sql
注意，其中的“grant ...”语句修改了数据库的用户权限设置。

guestbook.sql
create database guestbook;

connect guestbook;

create table guestbook (
id int(11) not null auto_increment,
name varchar(255) not null default '',
entrydate datetime not null default '0000-00-00 00:00:00',
comment text not null,
primary key (id),
key entrydate (entrydate)
) type=myisam;

grant all on guestbook.* to [email protected] identified by 'foobar';

smarty程序应用范例：留言簿（guestbook）第三节

/web/www.example.com/smarty/guestbook/libs/sql.lib.php

<?php/*** project: guestbook sample smarty application* author: monte ohrt <monte [at] ohrt [dot] com>* date: march 14th, 2005* file: sql.lib.php* version: 1.0*/// define the query typesdefine('sql_none', 1);define('sql_all', 2);define('sql_init', 3);// define the query formatsdefine('sql_assoc', 1);define('sql_index', 2);class sql {        var $db = null;    var $result = null;    var $error = null;    var $record = null;        /**     * class constructor     */    function sql() { }        /**     * connect to the database     *     * @param string $dsn the data source name     */    function connect($dsn) {        $this->db = db::connect($dsn);        if(db::iserror($this->db)) {            $this->error = $this->db->getmessage();            return false;        }                return true;    }        /**     * disconnect from the database     */    function disconnect() {        $this->db->disconnect();       }        /**     * query the database     *     * @param string $query the sql query     * @param string $type the type of query     * @param string $format the query format     */    function query($query, $type = sql_none, $format = sql_index) {        $this->record = array();        $_data = array();                // determine fetch mode (index or associative)        $_fetchmode = ($format == sql_assoc) ? db_fetchmode_assoc
        : null;                $this->result = $this->db->query($query);        if (db::iserror($this->result)) {            $this->error = $this->result->getmessage();            return false;        }        switch ($type) {            case sql_all:                // get all the records                while($_row = $this->result->fetchrow($_fetchmode)) {                    $_data[] = $_row;                   }                $this->result->free();                            $this->record = $_data;                break;            case sql_init:                // get the first record                $this->record = $this->result->fetchrow($_fetchmode);                break;            case sql_none:            default:                // records will be looped over with next()                break;           }        return true;    }        /**     * connect to the database     *     * @param string $format the query format     */    function next($format = sql_index) {        // fetch mode (index or associative)        $_fetchmode = ($format == sql_assoc) ? db_fetchmode_assoc 
        : null;        if ($this->record = $this->result->fetchrow($_fetchmode)) {            return true;        } else {            $this->result->free();            return false;        }                }    }?>

sql.lib.php 是我们基于pear::db的数据库操作类的集合。它有助于尽可能地简化程序的数据库操作语法和代码。你可以拷贝以上代码，而不用过分担心是不是能理解它们，除非你觉得一定要。

接下来是相关参数的速成示例（crash course）：

$guestbook->sql->query("select * from guestbook", sql_all);
print_r($guestbook->sql->record);

输出结果：
array
(
[0] => array
(
[0] => 1
[1] => monte
[2] => 2005-03-12 17:23:32
[3] => test entry 1
)

[1] => array
(
[0] => 2
[1] => monte
[2] => 2005-03-12 17:23:33
[3] => test entry 2
)

[2] => array
(
[0] => 3
[1] => monte
[2] => 2005-03-12 17:23:35
[3] => test entry 3
)

)

整个留言簿的内容都显示出来了。“sql_all”会得到所有的查询记录。

$guestbook->sql->query("select * from guestbook");
while($guestbook->sql->next()) {
print_r($guestbook->sql->record);
}

输出结果:
array
(
[0] => 1
[1] => monte
[2] => 2005-03-12 17:23:32
[3] => test entry 1
)

array
(
[0] => 2
[1] => monte
[2] => 2005-03-12 17:23:33
[3] => test entry 2
)

array
(
[0] => 3
[1] => monte
[2] => 2005-03-12 17:23:35
[3] => test entry 3
)

使用循环的方式一个一个地显示所有记录。如果没有设置query()的第二个参数，那么得到的数据库记录结果会被next()从头到尾遍历。

$guestbook->sql->query("select * from guestbook", sql_init);
print_r($guestbook->sql->record);

输出结果：
array
(
[0] => 1
[1] => monte
[2] => 2005-03-12 17:23:32
[3] => test entry 1
)

输出结果仅仅是一条数据库记录（第一条记录）。 “sql_init”只得到一条记录。

$guestbook->sql->query("select * from guestbook", sql_init, sql_assoc);
print_r($guestbook->sql->record);

输出结果：
array
(
[id] => 1
[name] => monte
[entrydate] => 2005-03-12 17:23:32
[comment] => test entry 1
)

把“sql_assoc”作为第三参数传递给query()会使返回的结果是一个联合数组，形如：fieldname => value。

$guestbook->sql->query("select * from guestbook");
while($guestbook->sql->next(sql_assoc)) {
print_r($guestbook->sql->record);
}

输出结果：
array
(
[id] => 1
[name] => monte
[entrydate] => 2005-03-12 17:23:32
[comment] => test entry 1
)

array
(
[id] => 2
[name] => monte
[entrydate] => 2005-03-12 17:23:33
[comment] => test entry 2
)

array
(
[id] => 3
[name] => monte
[entrydate] => 2005-03-12 17:23:35
[comment] => test entry 3
)

把“sql_assoc”作为参数传递给next()也会使返回的结果是一个联合数组。

smarty程序应用范例：留言簿（guestbook）第四节

/web/www.example.com/smarty/guestbook/libs/guestbook.lib.php

<?php/*** project: guestbook sample smarty application* author: monte ohrt <monte [at] ohrt [dot] com>* date: march 14th, 2005* file: guestbook.lib.php* version: 1.0*//*** guestbook application library**/class guestbook {    // database object    var $sql = null;    // smarty template object    var $tpl = null;    // error messages    var $error = null;        /**     * class constructor     */    function guestbook() {        // instantiate the sql object        $this->sql =& new guestbook_sql;        // instantiate the template object        $this->tpl =& new guestbook_smarty;    }        /**     * display the guestbook entry form     *     * @param array $formvars the form variables     */    function displayform($formvars = array()) {        // assign the form vars        $this->tpl->assign('post',$formvars);        // assign error message        $this->tpl->assign('error', $this->error);        $this->tpl->display('guestbook_form.tpl');    }        /**     * fix up form data if necessary     *     * @param array $formvars the form variables     */    function mungeformdata(&$formvars) {        // trim off excess whitespace        $formvars['name'] = trim($formvars['name']);        $formvars['comment'] = trim($formvars['comment']);    }    /**     * test if form information is valid     *     * @param array $formvars the form variables     */    function isvalidform($formvars) {        // reset error message        $this->error = null;                // test if "name" is empty        if(strlen($formvars['name']) == 0) {            $this->error = 'name_empty';            return false;         }        // test if "comment" is empty        if(strlen($formvars['comment']) == 0) {            $this->error = 'comment_empty';            return false;         }                // form passed validation        return true;    }        /**     * add a new guestbook entry     *     * @param array $formvars the form variables     */    function addentry($formvars) {        $_query = sprintf(            "insert into guestbook values(0,'%s',now(),'%s')",            mysql_escape_string($formvars['name']),            mysql_escape_string($formvars['comment'])        );                return $this->sql->query($_query);            }        /**     * get the guestbook entries     */    function getentries() {        $this->sql->query(            "select * from guestbook order by entrydate desc",            sql_all,            sql_assoc        );        return $this->sql->record;       }        /**     * display the guestbook     *     * @param array $data the guestbook data     */    function displaybook($data = array()) {        $this->tpl->assign('data', $data);        $this->tpl->display('guestbook.tpl');            }}?>

guestbook.lib.php 是我们这个程序的应用类。它包含了整个程序的实现逻辑。让我们看看每一个方法。

类方法： guestbook()
/**
* class constructor
*/
function guestbook() {

// instantiate the sql object
$this->sql =& new guestbook_sql;
// instantiate the template object
$this->tpl =& new guestbook_smarty;
}

构造函数。每次我们使用这个留言簿对象时都执行。它把sql语句和smarty对象作为自己的属性，我们以后可以通过这个对象的方法来访问和使用它们（sql语句和smarty对象）。

类方法： displayform()
/**
* display the guestbook entry form
*
* @param array $formvars the form variables
*/
function displayform($formvars = array()) {

// assign the form vars
$this->tpl->assign('post',$formvars);
// assign error message
$this->tpl->assign('error', $this->error);
$this->tpl->display('guestbook_form.tpl');

}

displayform() 该方法用于显示留言书写表单。它指派了模板文件中留言书写表单的变量和验证表单时的出错提示，然后把这个表单显示出来。

类方法： mungeformdata()
/**
* fix up form data if necessary
*
* @param array $formvars the form variables
*/
function mungeformdata(&$formvars) {

// trim off excess whitespace
$formvars['name'] = trim($formvars['name']);
$formvars['comment'] = trim($formvars['comment']);

}

mungeformdata() 该方法删掉来自表单输入内容开头和结尾的空白部分。这个方法在验证表单输入内容时最先调用。注意，表单信息是通过引用的办法传入本方法的，所以任何改变都会导致原始的数组内容（表单内容）发生改变。

类方法： isvalidform()
/**
* test if form information is valid
*
* @param array $formvars the form variables
*/
function isvalidform($formvars) {

// reset error message
$this->error = null;

// test if "name" is empty
if(strlen($formvars['name']) == 0) {
$this->error = 'name_empty';
return false;
}

// test if "comment" is empty
if(strlen($formvars['comment']) == 0) {
$this->error = 'comment_empty';
return false;
}

// form passed validation
return true;
}

isvalidform() 该方法验证表单的输入。这里仅仅简单地验证表单的‘name’和‘comment’控件是否为空。如果是空的，对应的出错代码将被指派为本类错误属性的值。（这些错误代码接下来将被模板文件使用用以显示对应的错误提示。）


类方法： addentry()
/**
* add a new guestbook entry
*
* @param array $formvars the form variables
*/
function addentry($formvars) {

$_query = sprintf(
"insert into guestbook values(0,'%s',now(),'%s')",
mysql_escape_string($formvars['name']),
mysql_escape_string($formvars['comment'])
);

return $this->sql->query($_query);

}

addentry 该方法将向数据库中插入一条新的留言簿条目。注意，插入数据库的值已经进行必要操作，以避免sql语法冲突和注入攻击。

类方法： getentries()
/**
* get the guestbook entries
*/
function getentries() {

$this->sql->query(
"select * from guestbook order by entrydate",
sql_all,
sql_assoc
);

return $this->sql->record;
}

getentries() 该方法将以“field => value”（效果同使用sql_assoc参数）的格式读出数据库中所有的留言簿条目。

类方法： displaybook()
/**
* display the guestbook
*
* @param array $data the guestbook data
*/
function displaybook($data = array()) {

$this->tpl->assign('data', $data);
$this->tpl->display('guestbook.tpl');

}

displaybook() 该方法将显示出留言簿的条目。数组$data即存储留言簿条目的数组，将用来指派给模板文件并在模板文件中显示出来。

smarty程序应用范例：留言簿（guestbook）第五节

我们这个留言簿程序有两个模板文件，一个用来显示留言一个用来书写留言。

/web/www.example.com/smarty/guestbook/templates/guestbook.tpl

{* smarty *}

<table border="0" width="300">
    <tr>
        <th colspan="2" bgcolor="#d1d1d1">guestbook entries (<a href="{$script_name}?action=add">add</a>)</th>
    </tr>
    {foreach from=$data item="entry"}
        <tr bgcolor="{cycle values="#dedede,#eeeeee" advance=false}">
            <td>{$entry.name|escape}</td>       
            <td align="right">{$entry.entrydate|date_format:"%e %b, %y %h:%m:%s"}</td>       
        </tr>
        <tr>
            <td colspan="2" bgcolor="{cycle values="#dedede,#eeeeee"}">{$entry.comment|escape}</td>
        </tr>
    {foreachelse}
        <tr>
            <td colspan="2">no records</td>
        </tr>
    {/foreach}
</table>

guestbook.tpl 是用于浏览留言簿的模板文件。它以一个foreach函数从头到尾遍历留言簿的数据，显示出每个留言簿条目的‘name’、‘date’和‘comment’字段信息。‘date’字段信息经日期格式化调节器（date_format）格式化后显示。 ‘name’和‘comment’字段信息使用转码调节器（escape）处理，以便原样显示html代码和避免脚本攻击。{cycle} 函数用来在表格中隔两行显示不同的表格背景色。

/web/www.example.com/smarty/guestbook/templates/guestbook_form.tpl

<form action="{$script_name}?action=submit" method="post">

<table border="1">

    {if $error ne ""}
        <tr>
            <td bgcolor="yellow" colspan="2">
                {if $error eq "name_empty"}you must supply a name.
                {elseif $error eq "comment_empty"} you must supply a comment.
                {/if}
            </td>
        </tr>
    {/if}
    <tr>
        <td>name:</td>
        <td><input type="text" name="name" value="{$post.name|escape}" size="40"></td>
    </tr>
    <tr>
        <td valign="top">comment:</td>
        <td><textarea name="comment" cols="40" rows="10">{$post.comment|escape}</textarea></td>
    </tr>
    <tr>
        <td colspan="2" align="center"><input type="submit" value="submit"></td>
    </tr>

</table>


</form>

guestbook_form.tpl 是用来书写留言的模板文件。如果因为通不过表单验证产生错误而重新显示表单，已填写的表单内容仍然存在，并且错误代码和错误信息也会显示出来。表单里的内容已经做了html转码处理，所以没有了html标记或者引号字符的冲突问题。（这个非常重要！）

通过这个范例程序，我们熟悉了几个开发smarty驱动的程序所需要的关键知识点。如下：

* 所有与页面表现相关的元素都包含在模板文件里。我们没有从模板文件外部指派html标签或者其他任何与页面表现相关的元素到模板文件中。唯一从外部指派到页面的只有需要显示的内容，在这里而言就是留言簿的条目。

* 错误提示也由模板文件来维护。我们没有（从模板文件外部）指派错误提示本身，而是指派了错误代码用于确定哪条错误提示需要被显示出来。另一个维护错误提示的方法是使用smarty的设置文件（config files），在那里（在config file里），我们以“error_code = error message”的格式存储错误提示，然后用{$smarty.config.$error_code} 方法根据错误代码显示错误提示。

* php 对象（们）相比于过程化的函数＋沉闷的参数更能便捷灵活地传递信息从而（应）被广泛使用。（如同sql/template 对象和错误代码的使用）

希望这个范例能给你一个思路，一个在你的程序开发工作中使用smarty，把程序中的表现逻辑与实现逻辑干净地分离开来的思路。