系统支持任何的AJAX类库,Action类提供了ajaxReturn方法用于AJAX调用后返回数据给客户端。并且支持JSON、XML和EVAL三种方式给客户端接受数据,通过配置DEFAULT_AJAX_RETURN进行设置,默认配置采用JSON格式返回数据,在选择不同的AJAX类库的时候可以使用不同的方式返回数据。
要使用ThinkPHP的ajaxReturn方法返回数据的话,需要遵守一定的返回数据的格式规范。ThinkPHP返回的数据格式包括:
status | 操作状态 |
info | 提示信息 |
data | 返回数据 |
调用示例:
$this->ajaxReturn(返回数据,提示信息,操作状态);
返回数据data可以支持字符串、数字和数组、对象,返回客户端的时候根据不同的返回格式进行编码后传输。如果是JSON格式,会自动编码成JSON字符串,如果是XML方式,会自动编码成XML字符串,如果是EVAL方式的话,只会输出字符串data数据,并且忽略status和info信息。
下面是一个简单的例子:
$User=M("User");//实例化User对象
$result = $User->add($data);
if ($result){
//成功后返回客户端新增的用户ID,并返回提示信息和操作状态
$this->ajaxReturn($result,"新增成功!",1);
}else{
//错误后返回错误的操作状态和提示信息
$this->ajaxReturn(0,"新增错误!",0);
}
注意,确保你是使用AJAX提交才使用ajaxReturn方法。
在客户端接受数据的时候,根据使用的编码格式进行解析即可。如果需要改变Ajax返回的数据格式,可以在控制器Action中增加ajaxAssign方法定义,定义格式如下:
public function ajaxAssign(&$result) {
// 返回数据中增加url属性
$result['url'] = $this->url;
}
3.1版本以后,ajaxReturn方法可以更加灵活的进行ajax传值,并且废弃了ajaxAssign方法扩展。能够完全定义传值的数组和类型,例如:
$data['status'] = 1;
$data['info'] = 'info';
$data['size'] = 9;
$data['url'] = $url;
$this->ajaxReturn($data,'JSON');
data传值数组可以随意定义。
改进后的ajaxReturn方法也兼容之前的写法:
$this->ajaxReturn($data,'info',1);
系统会自动把info和1两个参数并入$data数组中,等同于赋值
$data['info'] = 'info';
$data['status'] = 1;