为了能方便大家学习和掌握,在这里汇总下ThinkPHP中的经典函数用法,无论你是资深还是菜鸟TPer,绝对不容错过哦 ^_^
A 函数:实例化控制器
R 函数:直接调用控制器的操作方法
C 函数:设置和获取配置参数
L 函数:设置和获取语言变量
D 函数:实例化模型
M 函数:实例化模型(无需定义模型类)
N 函数:计数器
G 函数:调试统计
U 函数:URL地址生成
I 函数:安全获取系统输入变量
S 函数:缓存设置和存取
F 函数:快速缓存设置和存取
session函数:Session操作
cookie函数:Cookie操作
import函数:类库导入
ThinkPHP函数详解:A方法
A方法用于在内部实例化控制器,调用格式:
A('[项目://][分组/]模块','控制器层名称')
最简单的用法:
$User = A('User');
表示实例化当前项目的UserAction控制器(这个控制器对应的文件位于Lib/Action/UserAction.class.php),如果采用了分组模式,并且要实例化另外一个Admin分组的控制器可以用:
$User = A('Admin/User');
$User = A('Admin://User');
$User = A('User','Event);
实例化控制器后,就可以调用该控制器中的方法,不过需要注意的情况是,在跨项目调用的情况下,如果你的操作方法 有针对当前控制器的特殊变量操作,会有一些未知的问题,所以,一般来说,官方建议需要公共调用的控制器层单独开发,不要有太多的依赖关系。
ThinkPHP函数详解:R方法
R方法用于调用某个控制器的操作方法,是A方法的进一步增强和补充。
R方法的调用格式:
R('[项目://][分组/]模块/操作','参数','控制器层名称')
class UserAction extends Action {
public function detail($id){
return M('User')->find($id);
}
}
$data = R('User/detail',array('5'));
表示调用User控制器的detail方法(detail方法必须是public类型),返回值就是查询id为5的一个用户数据。如果你要调用的操作方法是没有任何参数的话,第二个参数则可以留空,直接使用:
$data = R('User/detail');
R('Admin/User/detail',array('5'));
R('Admin://User/detail',array('5'));
class UserApi extends Action {
public function detail($id){
return M('User')->find($id);
}
}
$data = R('User/detail',array('5'),'Api');
同时,R方法调用操作方法的时候可以支持操作后缀设置C('ACTION_SUFFIX'),如果你设置了操作方法后缀,仍然不需要更改R方法的调用方式。
ThinkPHP函数详解:C方法
由于采用了函数重载设计,所以用法较多,我们来一一说明下。
设置参数
C('DB_NAME','thinkphp');
C('db_name','thinkphp');
C('USER.USER_ID',8);
$config['user_id'] = 1;
$config['user_type'] = 1;
C($config);
C('USER_ID',1);
C('USER_TYPE',1);
$userId = C('USER_ID');
$userType = C('USER_TYPE');
$userId = C('USER.USER_ID');
$config = C();
$config['user_id'] = 1;
$config['user_type'] = 1;
C($config,'name');
$config = C('','name');
其中name就是前面保存参数时用的缓存的标识,必须一致才能正确取回保存的参数。取回的参数会和当前的配置参数合并,无需手动合并。
ThinkPHP函数详解:L方法
L方法用于启用多语言的情况下,设置和获取当前的语言定义。
调用格式:L('语言变量'[,'语言值'])
L('LANG_VAR','语言定义');
L('lang_var','语言定义');
$lang['lang_var1'] = '语言定义1';
$lang['lang_var2'] = '语言定义2';
$lang['lang_var3'] = '语言定义3';
L($lang);
$langVar = L('LANG_VAR');
$langVar = L('lang_var');
$lang = L();
{$Think.lang.lang_var}
来输出语言定义。
ThinkPHP函数详解:D方法
从本篇开始,我们会陆续给大家详细说明下框架内置函数的用法。
D方法应该是用的比较多的方法了,用于实例化自定义模型类,是ThinkPHP框架对Model类实例化的一种封装,并实现了单例模式,支持跨项目和分组调用,调用格式如下:
D('[项目://][分组/]模型','模型层名称')
// 实例化User模型
$User = D('User');
import('@.Model.UserModel');
$User = new UserModel();
new Model('User');
//实例化Admin项目的User模型
D('Admin://User')
//实例化Admin分组的User模型
D('Admin/User')
// 实例化UserService类
$User = D('User','Service');
// 实例化UserLogic类
$User = D('User','Logic');
D('User','Service');
import('@.Service.UserService');
$User = new UserSerivce();
ThinkPHP函数详解:M方法
M方法用于实例化一个基础模型类,和D方法的区别在于:
1、不需要自定义模型类,减少IO加载,性能较好;
2、实例化后只能调用基础模型类(默认是Model类)中的方法;
3、可以在实例化的时候指定表前缀、数据库和数据库的连接信息;
D方法的强大则体现在你封装的自定义模型类有多强,不过随着新版ThinkPHP框架的基础模型类的功能越来越强大,M方法也比D方法越来越实用了。
M方法的调用格式:
M('[基础模型名:]模型名','数据表前缀','数据库连接信息')
我们来看下M方法具体有哪些用法:
在没有定义任何模型的时候,我们可以使用下面的方法实例化一个模型类来进行操作:
//实例化User模型
$User = M('User');
//执行其他的数据操作
$User->select();
$User = M('User');
$User = new Model('User');
表示操作think_user表。
2、实例化其他公共模型类
$User = M('CommonModel:User');
$User = new CommonModel('User');
3、传入表前缀、数据库和其他信息
$User = M('db2.User','think_');
$User = M('db1.User',null);
表示实例化Model模型类,并操作db1数据库中的user表。
$User = M('User','think_','mysql://user_a:1234@localhost:3306/thinkphp');
'DB_CONFIG'=>'mysql://user_a:1234@localhost:3306/thinkphp';
$User = M('User','think_','DB_CONFIG');
$User = M('CommonModel:db2.User','think_');
M('UserLogic:User');
D('User','Logic');
实现同样的功能。
ThinkPHP函数详解:N方法
N方法属于计数器方法,被用于核心的查询、缓存统计的计数和统计。但是其实可以用于应用的其他计数用途,用法比较简单,调用格式:
N('计数位置'[,'步进值'])
N('read',1);
$count = N('read');
N('score',5);
需要注意的是,N方法页面执行完毕后的统计结果不会带入下次统计。
G方法的华丽升级
G方法的作用包括标记位置和区间统计两个功能,下面来看下具体用法:
1.标记位置
G('begin');
表示把当前位置标记为begin标签,并且记录当前位置的执行时间,如果环境支持的话,还能记录内存占用情况。可以在任何位置调用G方法标记。
2.运行时间统计
G('begin');
// ...其他代码段
G('end');
// ...也许这里还有其他代码
// 进行统计区间
echo G('begin','end').'s';
3.内存开销统计
echo G('begin','end','m').'kb';
忘掉debug_start、debug_end吧,大道至简,你懂的~
ThinkPHP函数详解:U方法
U方法用于完成对URL地址的组装,特点在于可以自动根据当前的URL模式和设置生成对应的URL地址,格式为:
U('地址','参数','伪静态','是否跳转','显示域名');
在模板中的调用格式需要采用 {:U('地址', '参数'…)} 的方式
基本用法
U方法的用法示例:
U('User/add') // 生成User模块的add操作地址
U('Home/User/add') // 生成Home分组的User模块的add操作地址
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('add') // 生成当前访问模块的add操作地址
U('Blog/read?id=1') // 生成Blog模块的read操作 并且id为1的URL地址
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')
U('Blog/read?id=1')
这个定义为例。
'URL_PATHINFO_DEPR'=>'_'
http://serverName/Blog_read_id_1
http://serverName/Blog/read/id/1.html
U('Blog/read','id=1','xml')
http://serverName/Blog/read/id/1.xml
路由支持
'news/:id\d'=>'News/read'
U('/news/1')
http://serverName/index.php/news/1
域名支持
U('Blog/[email protected]','id=1');
@后面传入需要指定的域名即可。
锚点支持
U('Blog/read#comment','id=1','html')
http://serverName/Blog/read/id/1.html#comment
U('Blog/read#comment@blog','id=1');
ThinkPHP函数详解:I方法
ThinkPHP的I方法是3.1.3版本新增的,如果你是之前的3.*版本的话,可以直接参考使用3.1快速入门教程系列的变量部分。(该用法将会在将来的版本中废弃,事实上,如果你仍然还在使用该方式会有警告错误提示)
概述
正如你所见到的一样,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 数组
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']
echo I('param.id');
http://serverName/index.php/New/2013/06/01
echo I('param.1'); // 输出2013
echo I('param.2'); // 输出06
echo I('param.3'); // 输出01
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'
'DEFAULT_FILTER' => 'htmlspecialchars'
I('get.name'); // 等同于 htmlspecialchars($_GET['name'])
'DEFAULT_FILTER' => 'strip_tags,htmlspecialchars'
I('get.name'); // 等同于 htmlspecialchars(strip_tags($_GET['name']))
echo I('get.name','','strip_tags'); // 等同于 strip_tags($_GET['name'])
I('post.email','',FILTER_VALIDATE_EMAIL);
I('post.email','','email');
可以支持的过滤名称必须是filter_list方法中的有效值(不同的服务器环境可能有所不同),可能支持的包括:
I('get.name','',NULL);
一旦过滤参数设置为NULL,即表示不再进行任何的过滤。
ThinkPHP函数详解:cache方法
cache方法是3.0版本开始新增的缓存管理方法。
注意:3.1.2版本后因cache方法并入原S方法,所以cache方法不再建议使用,用S方法即可。
cache 用于缓存设置、获取、删除操作 |
|
用法 |
cache($name, $value='',$options=null) |
参数 |
name(必须):如果传入数组 则表示进行缓存初始化,如果是字符串则表示缓存赋值、获取或者删除操作。 |
返回值 |
见详(根据具体的用法返回不同的值) |
缓存初始化
cache方法传入数组即表示进行缓存初始化,例如:
1cache(array('type'=>'xcache','prefix'=>'think','expire'=>600));
支持的配置参数根据不同的缓存方式(由type参数设置),通用的缓存参数包括:
参数名 |
说明 |
expire |
缓存有效期(时间为秒) |
length |
缓存队列长度 |
prefix |
缓存标识前缀 |
type |
缓存类型 |
缓存初始化操作后返回的是一个缓存实例化对象。
如果你没有进行缓存初始化的话,cache方法会在你进行缓存操作之前自动初始化(用系统默认的缓存方式和缓存参数),默认缓存配置参数包括:
/* 数据缓存设置 */
'DATA_CACHE_TIME' => 0, // 数据缓存有效期 0表示永久缓存
'DATA_CACHE_COMPRESS' => false, // 数据缓存是否压缩缓存
'DATA_CACHE_CHECK' => false, // 数据缓存是否校验缓存
'DATA_CACHE_PREFIX' => '', // 缓存前缀
'DATA_CACHE_TYPE' => 'File', // 数据缓存类型
'DATA_CACHE_PATH' => TEMP_PATH,// 缓存路径设置 (仅对File方式有效)
'DATA_CACHE_SUBDIR' => false, // 使用子目录缓存 (根据缓存标识的哈希创建子目录)
'DATA_PATH_LEVEL' => 1, // 子目录缓存级别
这些具体的缓存参数的用法,我们以后会在快速入门:缓存中详细描述。
缓存设置
cache('name','value');
cache('name','value',3600);
cache('name','value',array('type'=>'xcache','prefix'=>'think','expire'=>600));
$value = cache('name');
如果缓存标识不存在或者已经过期,则返回false,否则返回缓存值。
cache('name',NULL);
$cache = cache(array('type'=>'xcache','prefix'=>'think','expire'=>600));
$cache->name = 'value'; // 设置缓存
$value = $cache->name; // 获取缓存
unset($cache->name); // 删除缓存
如果你设置了缓存前缀的话,对应的缓存操作只是对应该缓存前缀标识的,不会影响其他的缓存。
ThinkPHP函数详解:F方法
我们已经了解了ThinkPHP中的S方法的用法,F方法其实是S方法的一个子集功能,仅用于简单数据缓存,并且只能支持文件形式,不支持缓存有效期,因为采用的是PHP返回方式,所以其效率较S方法较高,因此我们也称之为快速缓存方法。
F方法的特点是:
简单数据缓存;
文件形式保存;
采用PHP返回数据方式加载缓存;
支持子目录缓存以及自动创建;
支持删除缓存和批量删除;
写入和读取缓存
F('data','test data');
$Data = F('data');
F('user/data',$data); // 缓存写入
F('user/data'); // 读取缓存
F('level1/level2/data',$data);
F('data',$data,TEMP_PATH);
F('data','',TEMP_PATH);
删除缓存
F('data',NULL);
F('user/*',NULL);
F('user/[^a]*',NULL);
ThinkPHP函数详解:session方法
Session 用于Session 设置、获取、删除和管理操作 |
|
用法 |
session($name, $value='') |
参数 |
name(必须):如果传入数组 则表示进行session初始化,如果传入null表示清空当前session,如果是字符串则表示session赋值、获取或者操作。 |
返回值 |
见详(根据具体的用法返回不同的值) |
session函数是一个多元化操作函数,传入不同的参数调用可以完成不同的功能操作,包括下面一些功能。[-more-]
session初始化设置
session(array('name'=>'session_id','expire'=>3600));
参数名 |
说明 |
id |
session_id值 |
name |
session_name 值 |
path |
session_save_path 值 |
prefix |
session 本地化空间前缀 |
expire |
session.gc_maxlifetime 设置值 |
domain |
session.cookie_domain 设置值 |
use_cookies |
session.use_cookies 设置值 |
use_trans_sid |
session.use_trans_sid 设置值 |
cache_limiter |
session_cache_limiter设置值 |
cache_expire |
session_cache_expire设置值 |
type |
session hander类型,可以使用hander驱动扩展 |
Session初始化设置方法 无需手动调用,在App类的初始化工作结束后会自动调用,通常项目只需要配置SESSION_OPTIONS参数即可,SESSION_OPTIONS参数的设置是一个数组,支持的索引名和前面的session初始化参数相同。
'SESSION_AUTO_START' =>false
关闭自动启动后可以项目的公共文件或者在控制器中通过手动调用session_start或者session('[start]') 启动session。
session赋值
session('name','value'); //设置session
$_SESSION['name'] = 'value';
session取值
$value = session('name');
$value = $_SESSION['name'];
session删除
session('name',null); // 删除name
相当于:
unset($_SESSION['name']);
session(null); // 清空当前的session
相当于:
$_SESSION = array();
session判断
session('?name');
isset($_SESSION['name']);
session管理
session方法支持一些简单的session管理操作,用法如下:
操作名 |
含义 |
start |
启动session |
pause |
暂停session写入 |
destroy |
销毁session |
regenerate |
重新生成session id |
session('[pause]'); // 暂停session写入
session('[start]'); // 启动session
session('[destroy]'); // 销毁session
session('[regenerate]'); // 重新生成session id
本地化支持
$_SESSION['name'] 变成 $_SESSION['前缀']['name']
假设前缀设置为think,则
赋值操作:
session('name','value'); //设置session
$_SESSION['think']['name'] = 'value';
$value = session('name');
$value = $_SESSION['think']['name'];
session('name',null);
unset($_SESSION['think']['name']);
清空操作:
session(null);
相当于:unset($_SESSION['think']);
判断操作:
session('?name');
相当于:
isset($_SESSION['think']['name']);
ThinkPHP函数详解:cookie方法
cookie函数也是一个多元化操作函数,完成cookie的设置、获取和删除操作。
Cookie 用于Cookie 设置、获取、删除操作 |
|
用法 |
cookie($name, $value='', $option=null) |
参数 |
name(必须):要操作的cookie变量 |
返回值 |
见详(根据具体的用法返回不同的值) |
Cookie设置
cookie('name','value'); //设置cookie
cookie('name','value',3600); // 指定cookie保存时间
3.1版本开始,cookie方法增加对数组的支持(采用轻量级的json编码格式保存 减少存储空间),例如:[-more-]
cookie('name',array('name1','name2'));
cookie('name','value',array('expire'=>3600,'prefix'=>'think_'))
cookie('name','value','expire=3600&prefix=think_')
和上面的用法等效。
传入的option参数支持prefix,expire,path,domain四个索引参数,如果没有传入或者传入空值的话,会默认取COOKIE_PREFIX、COOKIE_EXPIRE、COOKIE_PATH和COOKIE_DOMAIN四个配置参数。如果只传入个别参数,那么也会和默认的配置参数合并。
Cookie获取
$value = cookie('name');
$value = $_COOKIE['name']
$value = $_COOKIE['前缀+name']
Cookie删除
cookie('name',null);
cookie(null); // 清空当前设定前缀的所有cookie值
cookie(null,'think_'); // 清空指定前缀的所有cookie值
ThinkPHP函数详解:import方法
import方法是ThinkPHP框架用于类库导入的封装实现,尤其对于项目类库、扩展类库和第三方类库的导入支持,import方法早期的版本可以和java的import方法一样导入目录和通配符导入,后来考虑到性能问题,在后续的版本更新中不断改进和简化了,所以现在的用法比较简单明了。调用格式:
import('类库名', '起始路径', '类库后缀')
imprt方法有一个别名vendor方法,专门用于导入第三方类库,区别在于起始路径和类库后缀默认值不同。
我们来分析下具体的用法:
import('Think.Util.Array');
require THINK_PATH.'Lib/Util/Array.class.php';
import('Think.Util.U1.ClassA');
import('Think.Util.U1.A2.ClassB');
import('ORG.Util.Image');
import('Com.Sina.OAuth');
import("MyApp.Action.UserAction");
import("MyApp.Model.InfoModel");
import("@.Action.UserAction");
import("@.Model.InfoModel");
import('Common.MyClass',APP_PATH,'.php');
import('MyClass',APP_PATH.'Common','.php');
import("RBAC.AccessDecisionManager",dirname(__FILE__),".php");
import("ORG.User.Info");
import("ORG.User#Info");
来导入。
第三方类库导入
Vendor('Zend.Filter.Dir');
Vendor('Zend.Filter.Dir',dirname(__FILE__),'.class.php');
return array(
'rbac' =>LIB_PATH.'Common/Rbac.class.php',
'page' =>LIB_PATH.'Common/Page.class.php',
);
import("rbac");
import("page");