ThinkPHP 单字母函数
A() 内部实例化控制器
D() 实例化自定义模型类
M() 实例化一个基础模型类
R() 调用某个控制器的操作方法
L() 启用多语言的情况下,设置和获取当前的语言定义
N() 计数器方法
G() 包括标记位置和区间统计两个功能
F() 用于简单数据缓存,并且只能支持文件形式
C() 用于设置、获取,以及保存配置参数
方法详解:
A方法用于在内部实例化控制器,调用格式:
A('[项目://][分组/]模块','控制器层名称')
最简单的用法:
$User = A('User');
表示实例化当前项目的UserAction控制器(这个控制器对应的文件位于Lib/Action/UserAction.class.php),如果采用了分组模式,并且要实例化另外一个Admin分组的控制器可以用:
$User = A('Admin/User');
也支持跨项目实例化(项目的目录要保持同级)
$User = A('Admin://User');
表示实例化Admin项目下面的UserAction控制器
3.1版本增加了分层控制器的支持,所以还可以用A方法实例化其他的控制器,例如:
$User = A('User','Event);
实例化UserEvent控制器(对应的文件位于Lib/Event/UserEvent.class.php)。
实例化控制器后,就可以调用该控制器中的方法,不过需要注意的情况是,在跨项目调用的情况下,如果你的操作方法 有针对当前控制器的特殊变量操作,会有一些未知的问题,所以,一般来说,官方建议需要公共调用的控制器层单独开发,不要有太多的依赖关系。
D方法应该是用的比较多的方法了,用于实例化自定义模型类,是ThinkPHP框架对Model类实例化的一种封装,并实现了单例模式,支持跨项目和分组调用,调用格式如下:
D('[项目://][分组/]模型','模型层名称')
方法的返回值是实例化的模型对象。
D方法可以自动检测模型类,如果存在自定义的模型类,则实例化自定义模型类,如果不存在,则会实例化Model基类,同时对于已实例化过的模型,不会重复去实例化。
D方法最常用的用法就是实例化当前项目的某个自定义模型,例如:
// 实例化User模型
$User = D('User');
会导入当前项目下面的Lib/Model/UserModel.class.php文件,然后实例化UserModel类,所以,实际上的代码可能和下面的等效:
import('@.Model.UserModel');
$User = new UserModel();
但是如果使用D方法的话,如果这个UserModel类不存在,则会自动调用
new Model('User');
并且第二次调用的时候无需再次实例化,可以减少一定的对象实例化开销。
D方法可以支持跨分组和项目实例化模型,例如:
//实例化Admin项目的User模型
D('Admin://User')
//实例化Admin分组的User模型
D('Admin/User')
注意:要实现跨项目调用模型的话,必须确保两个项目的目录结构是并列的。
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方法的区别在于:
1、不需要自定义模型类,减少IO加载,性能较好;
2、实例化后只能调用基础模型类(默认是Model类)中的方法;
3、可以在实例化的时候指定表前缀、数据库和数据库的连接信息;
D方法的强大则体现在你封装的自定义模型类有多强,不过随着新版ThinkPHP框架的基础模型类的功能越来越强大,M方法也比D方法越来越实用了。
M方法的调用格式:
M('[基础模型名:]模型名','数据表前缀','数据库连接信息')
我们来看下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');
实现同样的功能。
R方法用于调用某个控制器的操作方法,是A方法的进一步增强和补充。
R方法的调用格式:
R('[项目://][分组/]模块/操作','参数','控制器层名称')
例如,我们定义了一个操作方法为:
- 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');
也可以支持跨分组和项目调用,例如:
- 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方法的调用方式。
L方法用于启用多语言的情况下,设置和获取当前的语言定义。
调用格式:L('语言变量'[,'语言值'])
设置语言变量
除了使用语言包定义语言变量之外,我们可以用L方法动态设置语言变量,例如:
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。
[-more-]
获取语言变量
$langVar = L('LANG_VAR');
或者:
$langVar = L('lang_var');
如果参数为空,表示获取当前定义的全部语言变量(包括语言定义文件中的):
$lang = L();
或者我们也可以在模板中使用
{$Think.lang.lang_var}
来输出语言定义。
N方法属于计数器方法,被用于核心的查询、缓存统计的计数和统计。但是其实可以用于应用的其他计数用途,用法比较简单,调用格式:
N('计数位置'[,'步进值'])
例如,我们要统计页面中的查询次数,可以用
- N('read',1);
表示每次执行到该位置都会引起计数器加1,到页面结束之前,我们就可以用
- $count = N('read');
来统计当前页面执行的查询数目。
如果你希望计数器每次增加5,那么可以改变步进值,例如:
- N('score',5);
需要注意的是,N方法页面执行完毕后的统计结果不会带入下次统计。
G方法的作用包括标记位置和区间统计两个功能,下面来看下具体用法:
标记位置
G方法的第一个用法就是标记位置,例如:
- G('begin');
表示把当前位置标记为begin标签,并且记录当前位置的执行时间,如果环境支持的话,还能记录内存占用情况。可以在任何位置调用G方法标记。
运行时间统计
标记位置后,我们就可以再次调用G方法进行区间统计了,例如:
- G('begin');
- // ...其他代码段
- G('end');
- // ...也许这里还有其他代码
- // 进行统计区间
- echo G('begin','end').'s';
G('begin','end') 表示统计begin位置到end位置的执行时间(单位是秒),begin必须是一个已经标记过的位置,如果这个时候end位置还没被标记过,则会自动把当前位置标记为end标签,输出的结果类似于:
- 0.0056s
默认的统计精度是小数点后4位,如果觉得这个统计精度不够,还可以设置例如:
- G('begin','end',6).'s';
可能的输出会变成:
- 0.005587s
内存开销统计
如果你的环境支持内存占用统计的话,还可以使用G方法进行区间内存开销统计(单位为kb),例如:
- echo G('begin','end','m').'kb';
第三个参数使用m表示进行内存开销统计,输出的结果可能是:
- 625kb
同样,如果end标签没有被标记的话,会自动把当前位置先标记位end标签。
如果环境不支持内存统计,则该参数无效,仍然会进行区间运行时间统计。
忘掉debug_start、debug_end吧,大道至简,你懂的~
F方法其实是S方法的一个子集功能,仅用于简单数据缓存,并且只能支持文件形式,不支持缓存有效期,因为采用的是PHP返回方式,所以其效率较S方法较高,因此我们也称之为快速缓存方法。
F方法的特点是:
简单数据缓存;
文件形式保存;
采用PHP返回数据方式加载缓存;
支持子目录缓存以及自动创建;
支持删除缓存和批量删除;
写入和读取缓存
- F('data','test data');
默认的保存起始路径是DATA_PATH(该常量在默认配置位于RUNTIME_PATH.'Data/'下面),也就是说会生成文件名为DATA_PATH.'data.php'的缓存文件。
注意:确保你的缓存标识的唯一,避免数据覆盖和冲突。
下次读取缓存数据的时候,使用:
- $Data = F('data');
我们可以采用子目录方式保存,例如:
- F('user/data',$data); // 缓存写入
- F('user/data'); // 读取缓存
就会生成DATA_PATH.'user/data.php' 缓存文件,如果user子目录不存在的话,则会自动创建,也可以支持多级子目录,例如:
- F('level1/level2/data',$data);
如果需要指定缓存的起始目录,可以用下面的方式:
- F('data',$data,TEMP_PATH);
获取的时候则需要使用:
- F('data','',TEMP_PATH);
删除缓存
删除缓存也很简单,使用:
- F('data',NULL);
第二个参数传入NULL,则表示删除标识为data的数据缓存。
支持批量删除功能,尤其是针对子目录缓存的情况,假设我们要删除user子目录下面的所有缓存数据,可以使用:
- F('user/*',NULL);
又或者使用过滤条件删除,例如:
- F('user/[^a]*',NULL);
C方法是ThinkPHP用于设置、获取,以及保存配置参数的方法,使用频率较高。
了解C方法需要首先了解下ThinkPHP的配置,因为C方法的所有操作都是围绕配置相关的。ThinkPHP的配置文件采用PHP数组格式定义。
由于采用了函数重载设计,所以用法较多,我们来一一说明下。
设置参数
- C('DB_NAME','thinkphp');
表示设置DB_NAME配置参数的值为thinkphp,由于配置参数不区分大小写,所以下面的写法也是一样:[-more-]
- 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);
获取参数
要获取设置的参数,可以用:
- $userId = C('USER_ID');
- $userType = C('USER_TYPE');
如果USER_ID参数尚未定义过,则返回NULL。
也可以支持获取二级配置参数,例如:
- $userId = C('USER.USER_ID');
如果传入的配置参数为空,表示获取全部的参数:
- $config = C();
保存设置
3.1版本增加了一个永久保存设置参数的功能,仅针对批量赋值的情况,例如:
- $config['user_id'] = 1;
- $config['user_type'] = 1;
- C($config,'name');
在批量设置了config参数后,会连同当前所有的配置参数保存到缓存文件(或者其他配置的缓存方式)。
保存之后,如果要取回保存的参数,可以用
- $config = C('','name');
其中name就是前面保存参数时用的缓存的标识,必须一致才能正确取回保存的参数。取回的参数会和当前的配置参数合并,无需手动合并。