- D:Model类实例化
- M:实例化一个基础模型类
- U:完成对URL地址的组装
- I:用于更加方便和安全的获取系统输入变量
- C:用于设置、获取,以及保存配置参数
- A:在内部实例化控制器
- R:调用某个控制器的操作方法
- N:计数器方法
- L:用于启用多语言的情况下,设置和获取当前的语言定义
- F:仅用于简单数据缓存
以上是Think 系统函数库,在/Thinkphp/Common/functions.php中定义。为了方便查阅,所以我把ThinkPHP教程中的函数详解进行了整合。
D:Model类实例化
D方法应该是用的比较多的方法了,用于 实例化自定义模型类,是ThinkPHP框架对Model类实例化的一种封装,并实现了单例模式,支持跨项目和分组调用
调用格式: D(’[项目://][分组/]模型’,‘模型层名称’)
返回值是实例化的模型对象。
D方法可以自动检测模型类,如果存在自定义的模型类,则实例化自定义模型类,如果不存在,则会实例化Model基类,同时对于已实例化过的模型,不会重复去实例化。
1、D方法最常用的用法就是实例化当前项目的某个自定义模型,例如:
// 实例化User模型
$User = D('User');
会导入当前项目下面的Lib/Model/UserModel.class.php文件,然后实例化UserModel类,所以,实际上的代码可能和下面的等效:
import('@.Model.UserModel');
$User = new UserModel();
但是如果使用D方法的话,如果这个UserModel类不存在,则会自动调用
new Model('User');
并且第二次调用的时候无需再次实例化,可以减少一定的对象实例化开销
2、D方法可以支持跨分组和项目实例化模型,例如:
// 实例化Admin项目的User模型
D('Admin://User')
//实例化Admin分组的User模型
D('Admin/User')
注意:要实现跨项目调用模型的话,必须确保两个项目的目录结构是并列的。
3、3.1版本开始,由于增加了分层模型的支持,所以D方法也可以实例化其他的模型,例如:
// 实例化UserService类
$User = D('User','Service');
// 实例化UserLogic类
$User = D('User','Logic');
D('User','Service')
会导入Lib/Service/UserService.class.php,并实例化,等效于下面的代码:
import('@.Service.UserService');
$User = new UserSerivce();
M:实例化一个基础模型类
和D方法的区别在于:
- 不需要自定义模型类,减少IO加载,性能较好;
- 实例化后只能调用基础模型类(默认是Model类)中的方法;
- 可以在实例化的时候指定表前缀、数据库和数据库的连接信息;
D方法的强大则体现在你封装的自定义模型类有多强,不过随着新版ThinkPHP框架的基础模型类的功能越来越强大,M方法也比D方法越来越实用了。
调用格式: M(’[基础模型名:]模型名’,‘数据表前缀’,‘数据库连接信息’)
1、实例化基础模型(Model) 类,在没有定义任何模型的时候,我们可以使用下面的方法实例化一个模型类来进行操作
//实例化User模型
$User = M('User');
//执行其他的数据操作
$User->select();
这种方法最简单高效,因为不需要定义任何的模型类,所以支持跨项目调用。缺点也是因为没有自定义的模型类,因此无法写入相关的业务逻辑,只能完成基本的CURD操作。
$User = M('User');
其实等效于:
$User = new Model('User');
表示操作think_user表。M方法和D方法一样也有单例功能,多次调用并不会重复实例化。M方法的模型名参数在转换成数据表的时候会自动转换成小写,也就是说ThinkPHP的数据表命名规范是全小写的格式。
2、实例化其他公共模型类
第一种方式实例化因为没有模型类的定义,因此很难封装一些额外的逻辑方法,不过大多数情况下,也许只是需要扩展一些通用的逻辑,那么就可以尝试下面一种方法。
$User = M('CommonModel:User');
其实等效于
$User = new CommonModel('User');
因为系统的模型类都能够自动加载,因此我们不需要在实例化之前手动进行类库导入操作。模型类CommonModel必须继承Model。我们可以在CommonModel类里面定义一些通用的逻辑方法,就可以省去为每个数据表定义具体的模型类,如果你的项目已经有超过100个数据表了,而大多数情况都是一些基本的CURD操作的话,只是个别模型有一些复杂的业务逻辑需要封装,那么第一种方式和第二种方式的结合是一个不错的选择。
3、传入表前缀、数据库和其他信息
M方法有三个参数,第一个参数是模型名称(可以包括基础模型类和数据库),第二个参数用于设置数据表的前缀(留空则取当前项目配置的表前缀),第三个参数用于设置当前使用的数据库连接信息(留空则取当前项目配置的数据库连接信息),例如:
$User = M('db2.User','think_');
表示实例化Model模型类,并操作db2数据库中的think_user表。
如果第二个参数留空或者不传,表示使用当前项目配置中的数据表前缀,如果操作的数据表没有表前缀,那么可以使用:
$User = M('db1.User',null);
表示实例化Model模型类,并操作db1数据库中的user表。
如果你操作的数据库需要不同的用户账号,可以传入数据库的连接信息,例如:
$User = M('User','think_','mysql://user_a:1234@localhost:3306/thinkphp');
表示基础模型类用Model,然后对think_user表进行操作,用user_a账号进行数据库连接,操作数据库是thinkphp。
第三个连接信息参数可以使用DSN配置或者数组配置,甚至可以支持配置参数。
例如,在项目配置文件中配置了:
'DB_CONFIG'=>'mysql://user_a:1234@localhost:3306/thinkphp';
则可以使用
$User = M('User','think_','DB_CONFIG');
基础模型类和数据库可以一起使用,例如:
$User = M('CommonModel:db2.User','think_');
如果要实例化分层模型的话,利用公共模型类的方式,我们可以使用:
M('UserLogic:User');
来实例化UserLogic,虽然这样做的意义不大,因为可以用
D('User','Logic');
实现同样的功能。
U:完成对URL地址的组装
U方法用于完成对URL地址的组装,特点在于可以自动根据当前的URL模式和设置生成对应的URL地址
调用格式: U(‘地址’,‘参数’,‘伪静态’,‘是否跳转’,‘显示域名’);
在模板中使用U方法而不是固定写死URL地址的好处在于,一旦你的环境变化或者参数设置改变,你不需要更改模板中的任何代码。
模板中的调用格式: {:U(‘地址’, ‘参数’…)}
1、基本用法
U('User/add') // 生成User模块的add操作地址
也可以支持分组调用:
U('Home/User/add') // 生成Home分组的User模块的add操作地址
只是写操作名,表示调用当前模块
U('add') // 生成当前访问模块的add操作地址
除了分组、模块和操作名之外,我们也可以传入一些参数:
U('Blog/read?id=1') // 生成Blog模块的read操作 并且id为1的URL地址
U方法的第二个参数支持传入参数,支持数组和字符串两种定义方式,如果只是字符串方式的参数可以在第一个参数中定义,下面几种方式都是等效的:
U('Blog/cate',array('cate_id'=>1,'status'=>1))
U('Blog/cate','cate_id=1&status=1')
U('Blog/cate?cate_id=1&status=1')
但是不允许使用下面的定义方式来传参数:
U('Blog/cate/cate_id/1/status/1')
根据项目的不同URL设置,同样的U方法调用可以智能地对应产生不同的URL地址效果,例如针对:
U('Blog/read?id=1')
这个定义为例。
如果当前URL设置为普通模式的话,最后生成的URL地址是:
http://serverName/index.php?m=Blog&a=read&id=1
如果当前URL设置为PATHINFO模式的话,同样的方法最后生成的URL地址是:
http://serverName/index.php/Blog/read/id/1
如果当前URL设置为REWRITE模式的话,同样的方法最后生成的URL地址是:
http://serverName/Blog/read/id/1
如果你同时还设置了PATHINFO分隔符的话:
'URL_PATHINFO_DEPR'=>'_'
就会生成
http://serverName/Blog_read_id_1
如果当前URL设置为REWRITE模式,并且设置了伪静态后缀为html的话,同样的方法最后生成的URL地址是:
http://serverName/Blog/read/id/1.html
如果设置了多个伪静态支持,那么会自动取第一个伪静态后缀添加到URL地址后面,当然你也可以手动在U方法里面指定要生成的伪静态后缀,例如:
U('Blog/read','id=1','xml')
就会生成
http://serverName/Blog/read/id/1.xml
2、路由支持
U方法还可以支持路由,如果我们定义了一个路由规则为:
'news/:id\d'=>'News/read'
那么可以使用
U('/news/1')
最终生成的URL地址是:
http://serverName/index.php/news/1
3、如果你的应用涉及到多个子域名的操作地址,那么也可以在U方法里面指定需要生成地址的域名,例如:
U('Blog/read@blog.thinkphp.cn','id=1');
@后面传入需要指定的域名即可。
此外,U方法的第5个参数如果设置为true,表示自动识别当前的域名,并且会自动根据子域名部署设置APP_SUB_DOMAIN_DEPLOY和APP_SUB_DOMAIN_RULES自动匹配生成当前地址的子域名。
如果开启了URL_CASE_INSENSITIVE,则会统一生成小写的URL地址。
4、锚点支持 。3.1.2版本开始,U方法还可以支持生成URL地址中的锚点,例如:
U('Blog/read#comment','id=1','html')
就会生成
http://serverName/Blog/read/id/1.html#comment
如果域名和锚点同时使用的话,注意顺序为先锚点后域名,例如:
U('Blog/read#comment@blog','id=1');
I:用于更加方便和安全的获取系统输入变量
正如你所见到的一样,I方法是ThinkPHP众多单字母函数中的新成员,其命名来自于英文Input(输入),主要用于更加方便和安全的获取系统输入变量,可以用于任何地方
调用格式: I(‘变量类型.变量名’,[‘默认值’],[‘过滤方法’])
变量类型是指请求方式或者输入类型,包括:
变量类型 | 含义 |
---|---|
get | 获取GET参数 |
post | 获取POST参数 |
param | 自动判断请求类型获取GET、POST或者PUT参数 |
request | 获取REQUEST 参数 |
put | 获取PUT 参数 |
session | 获取 $_SESSION 参数 |
cookie | 获取 $_COOKIE 参数 |
server | 获取 $_SERVER 参数 |
globals | 获取 $GLOBALS参数 |
注意:
变量类型不区分大小写。
变量名则严格区分大小写。
默认值和过滤方法均属于可选参数。
用法
我们以GET变量类型为例,说明下I方法的使用:
echo I('get.id'); // 相当于 $_GET['id']
echo I('get.name'); // 相当于 $_GET['name']
支持默认值:
echo I('get.id',0); // 如果不存在$_GET['id'] 则返回0
echo I('get.name',''); // 如果不存在$_GET['name'] 则返回空字符串
采用方法过滤:
echo I('get.name','','htmlspecialchars');
// 采用htmlspecialchars方法对$_GET['name'] 进行过滤,如果不存在则返回空字符串
支持直接获取整个变量类型,例如:
I('get.'); // 获取整个$_GET 数组
用同样的方式,我们可以获取post或者其他输入类型的变量,例如:
I('post.name','','htmlspecialchars'); // 采用htmlspecialchars方法对$_POST['name'] 进行过滤,如果不存在则返回空字符串
I('session.user_id',0); // 获取$_SESSION['user_id'] 如果不存在则默认为0
I('cookie.'); // 获取整个 $_COOKIE 数组
I('server.REQUEST_METHOD'); // 获取 $_SERVER['REQUEST_METHOD']
param变量类型是框架特有的支持自动判断当前请求类型的变量获取方式,例如:
echo I('param.id');
如果当前请求类型是GET,那么等效于 $_GET[‘id’],如果当前请求类型是POST或者PUT,那么相当于获取 $_POST[‘id’] 或者 PUT参数id。
并且param类型变量还可以用数字索引的方式获取URL参数(必须是PATHINFO模式参数有效,无论是GET还是POST方式都有效)
例如:当前访问URL地址是
http://serverName/index.php/New/2013/06/01
那么我们可以通过
echo I('param.1'); // 输出2013
echo I('param.2'); // 输出06
echo I('param.3'); // 输出01
事实上,param变量类型的写法可以简化为:
I('id'); // 等同于 I('param.id')
I('name'); // 等同于 I('param.name')
变量过滤
使用I方法的时候 变量其实经过了两道过滤,首先是全局的过滤,全局过滤是通过配置VAR_FILTERS参数,这里一定要注意,3.1版本之后,VAR_FILTERS参数的过滤机制已经更改为采用array_walk_recursive方法递归过滤了,主要对过滤方法的要求是必须引用返回,所以这里设置htmlspecialchars是无效的,你可以自定义一个方法,例如:
function filter_default(&$value){
$value = htmlspecialchars($value);
}
然后配置:
'VAR_FILTERS'=>'filter_default'
如果需要进行多次过滤,可以用:
'VAR_FILTERS'=>'filter_default,filter_exp'
filter_exp方法是框架内置的安全过滤方法,用于防止利用模型的EXP功能进行注入攻击。
因为VAR_FILTERS参数设置的是全局过滤机制,而且采用的是递归过滤,对效率有所影响,所以,我们更建议直接对获取变量过滤的方式,除了在I方法的第三个参数设置过滤方法外,还可以采用配置DEFAULT_FILTER参数的方式设置过滤,事实上,该参数的默认设置是:
http://www.thinkphp.cn/document/308.html
C:用于设置、获取,以及保存配置参数
C方法是ThinkPHP用于设置、获取,以及保存配置参数的方法,使用频率较高。
了解C方法需要首先了解下ThinkPHP的配置,因为C方法的所有操作都是围绕配置相关的。ThinkPHP的配置文件采用PHP数组格式定义。
由于采用了函数重载设计,所以用法较多,我们来一一说明下。
1、设置参数
C('DB_NAME','thinkphp');
表示设置DB_NAME配置参数的值为thinkphp,由于配置参数不区分大小写,所以下面的写法也是一样:
C('db_name','thinkphp');
但是建议保持统一大写的配置定义规范。
项目的所有参数在未生效之前都可以通过该方法动态改变配置,最后设置的值会覆盖前面设置或者惯例配置里面的定义,也可以使用参数配置方法添加新的配置。
支持二级配置参数的设置,例如:
C('USER.USER_ID',8);
配置参数不建议超过二级。
如果要设置多个参数,可以使用批量设置,例如:
$config['user_id'] = 1;
$config['user_type'] = 1;
C($config);
如果C方法的第一个参数传入数组,就表示批量赋值,上面的赋值相当于:
C('USER_ID',1);
C('USER_TYPE',1);
2、获取参数
$userId = C('USER_ID');
$userType = C('USER_TYPE');
如果USER_ID参数尚未定义过,则返回NULL。
也可以支持获取二级配置参数,例如:
$userId = C('USER.USER_ID');
如果传入的配置参数为空,表示获取全部的参数:
$config = C();
3、保存设置。3.1版本增加了一个永久保存设置参数的功能,仅针对批量赋值的情况,例如:
$config['user_id'] = 1;
$config['user_type'] = 1;
C($config,'name');
在批量设置了config参数后,会连同当前所有的配置参数保存到缓存文件(或者其他配置的缓存方式)。
保存之后,如果要取回保存的参数,可以用
$config = C('','name');
其中name就是前面保存参数时用的缓存的标识,必须一致才能正确取回保存的参数。取回的参数会和当前的配置参数合并,无需手动合并。
A:在内部实例化控制器
调用格式: A(’[项目://][分组/]模块’,‘控制器层名称’)
1、最简单的用法:
$User = A('User');
表示实例化当前项目的UserAction控制器(这个控制器对应的文件位于Lib/Action/UserAction.class.php)
2、如果采用了分组模式,并且要实例化另外一个Admin分组的控制器可以用:
$User = A('Admin/User');
3、也支持跨项目实例化(项目的目录要保持同级)
$User = A('Admin://User');
表示实例化Admin项目下面的UserAction控制器
3.1版本增加了分层控制器的支持,所以还可以用A方法实例化其他的控制器,例如
$User = A('User','Event);
实例化UserEvent控制器(对应的文件位于Lib/Event/UserEvent.class.php)。
实例化控制器后,就可以调用该控制器中的方法,不过需要注意的情况是,在跨项目调用的情况下,如果你的操作方法 有针对当前控制器的特殊变量操作,会有一些未知的问题,所以,一般来说,官方建议需要公共调用的控制器层单独开发,不要有太多的依赖关系。
R:调用某个控制器的操作方法
R方法用于调用某个控制器的操作方法,是A方法的进一步增强和补充。
调用格式: R(’[项目://][分组/]模块/操作’,‘参数’,‘控制器层名称’)
1、我们定义了一个操作方法为:
class UserAction extends Action {
public function detail($id){
return M('User')->find($id);
}
}
那么就可以通过R方法在其他控制器里面调用这个操作方法(一般R方法用于跨模块调用)
$data = R('User/detail',array('5'));
表示调用User控制器的detail方法(detail方法必须是public类型),返回值就是查询id为5的一个用户数据。如果你要调用的操作方法是没有任何参数的话,第二个参数则可以留空,直接使用:
$data = R('User/detail');
2、也可以支持跨分组和项目调用,例如:
R('Admin/User/detail',array('5'));
表示调用Admin分组下面的User控制器的detail方法。
R('Admin://User/detail',array('5'));
表示调用Admin项目下面的User控制器的detail方法。
官方的建议是不要在同一层多太多调用,会引起逻辑的混乱,被公共调用的部分应该封装成单独的接口,可以借助3.1的新特性多层控制器,单独添加一个控制器层用于接口调用,例如,我们增加一个Api控制器层。
class UserApi extends Action {
public function detail($id){
return M('User')->find($id);
}
}
然后,使用R方法调用
$data = R('User/detail',array('5'),'Api');
也就是说,R方法的第三个参数支持指定调用的控制器层。
同时,R方法调用操作方法的时候可以支持操作后缀设置C(‘ACTION_SUFFIX’),如果你设置了操作方法后缀,仍然不需要更改R方法的调用方式。
N:计数器方法
N方法属于计数器方法,被用于核心的查询、缓存统计的计数和统计。但是其实可以用于应用的其他计数用途,用法比较简单,
调用格式: N(‘计数位置’[,‘步进值’])
例如,我们要统计页面中的查询次数,可以用
N('read',1);
表示每次执行到该位置都会引起计数器加1,到页面结束之前,我们就可以用
$count = N('read');
来统计当前页面执行的查询数目。
如果你希望计数器每次增加5,那么可以改变步进值,例如:
N('score',5);
需要注意的是,N方法页面执行完毕后的统计结果不会带入下次统计。
L:用于启用多语言的情况下,设置和获取当前的语言定义
调用格式: L(‘语言变量’[,‘语言值’])
1、设置语言变量
L('LANG_VAR','语言定义');
语言定义不区分大小写,所以下面也是等效的:
L('lang_var','语言定义');
不过规范起见,我们建议统一采用大写定义语言变量。
L方法支持批量设置语言变量,例如:
$lang['lang_var1'] = '语言定义1';
$lang['lang_var2'] = '语言定义2';
$lang['lang_var3'] = '语言定义3';
L($lang);
表示同时设置3个语言变量lang_var1 lang_var2和lang_var3。
2、获取语言变量
$langVar = L('LANG_VAR');
$langVar = L('lang_var');
如果参数为空,表示获取当前定义的全部语言变量(包括语言定义文件中的)
$lang = L();
或者我们也可以在模板中使用
{$Think.lang.lang_var}
来输出语言定义