Smarty3:自定义变量调解器插件
如果有一些变量在模版中需要特殊处理,系统中默认的变量调节器又没有提供这样的功能,就可以自定义变量调节器。smarty提供了两种扩充插件的机制:
通过Smarty对象中的registerPlugin()方法,将PHP编写的函数,注册到Smarty对象中,并在模版中使用
像系统默认的变量调节器一样,在Smarty库文件所在目录下的Plugins目录中,创建一个特定的文件扩展插件。
1. 使用registerPlugin()方法扩充变量调解器插件
registerPlugin()有三个参数:
使用字符串”modifier”指定插件的类型为修改器
插件的函数名称
定义的PHP回调函数
例如:在PHP脚本中声明一个函数为test(),将其注册为Smarty调解器”mystyle”,如下所示:
assign("var","这是一个字符串的数据,看看样式变量"); //使用registerPlugin()方法,将函数test()动态注册为模版中可以使用的修改器mystyle函数 $smarty->registerPlugin("modifier","mystyle","test"); //声明一个函数,为Smarty扩充修改器 function test ($var, $color, $size){ return ''.$var.''; } $smarty->display("test.tpl"); /*模版中通过使用 {$var|mystyle:"red":7}{*自定义的变量调解器mysql,将变量$var的字体改为红色和7号字*} */
除了可以将自定义函数注册为变量调解器函数,也可以将PHP中的系统函数直接使用registerPlugin()方法注册为插件,不过要注意确保PHP系统该函数的第一个参数是要处理的变量。否则需要自定义一个函数调整参数位置。
assign("var","这是一个字符串的数据,看看样式变量"); //直接将PHP系统函数substr(),注册成变量调解器函数substr $smarty->registerPlugin('modifier','substr','substr'); //因为PHP系统函数preg_match()函数的第一个参数不是要处理的变量,所以自定义demo()函数重新注册 function demo($var, $reg,$text){ return preg_match($reg,$text,$var); } $smarty->registerPlugin('modifier','regrep','demo'); $smarty->display('test.tpl');
2. 以特定文件方式扩充变量调解器插件
由于使用registerPlugin()方法,函数在PHP程序中声明,但是不在PHP程序中使用,和PHP脚本的其他函数混杂在一起,会导致PHP程序逻辑混乱。可读性差,因此建议以特定的文件方式扩充插件。
需要遵循smarty定义的规则。包括插件声明位置、文件的命名,函数的命名,参数的规则等的约束。
插件声明位置
由于自带的默认插件都在smarty类库下的plugins目录下。所以最好用addPluginsDir()方法指明自定义插件的位置。
$smarty->addPluginsDir(ROOT."plugins");//自定义插件目录
文件命名方式
modifier.修改器名称.php //以modifier为前缀,中间使要声明的修改器名称,以php结束
函数命名规则
smarty_modifier_修改器名称() //函数名称要以smarty_modifier_为前缀,再加上修改器名称
参数说明
参数的第一个参数会自动传入要修改的变量。修改器中的其他参数从第二个参数开始。
修改上述的修改器:修改器文件命名为modifier.mystyle.php,放在由addPluginsDir()方法添加的插件目录下:
'.$var.''; }
下一篇: JavaScript 原型继承