模型定义
模型定义
//定义一个User模型类:
namespace app\index\model;
use think\Model;
class User extends Model
{
//默认主键为自动识别,如果需要指定,可以设置属性:
protected $pk = 'uid';
}
模型会自动对应数据表,模型类的命名规则是除去表前缀的数据表名称,采用驼峰法命名,并且首字母大写
模型名 | 约定对应数据表(假设数据库的前缀定义是 think_) |
---|---|
User | think_user |
UserType | think_user_type |
设置数据表
如果你的规则和上面的系统约定不符合,那么需要设置Model类的数据表名称属性,以确保能够找到对应的数据表。
namespace app\index\model;
class User extends \think\Model
{
// 设置当前模型对应的完整数据表名称
protected $table = 'think_user';
// 设置当前模型的数据库连接
protected $connection = [
// 数据库类型
'type' => 'mysql',
// 服务器地址
'hostname' => '127.0.0.1',
// 数据库名
'database' => 'thinkphp',
// 数据库用户名
'username' => 'root',
// 数据库密码
'password' => '',
// 数据库编码默认采用utf8
'charset' => 'utf8',
// 数据库表前缀
'prefix' => 'think_',
// 数据库调试模式
'debug' => false,
];
}
//和连接数据库的参数一样,connection属性的值也可以设置为数据库的配置参数,而且也是官方推荐的方式,这样可以避免把数据库连接固化在代码里面。
模型调用
模型类可以使用静态调用或者实例化调用两种方式
// 静态调用
$user = User::get(1);
$user->name = 'thinkphp';
$user->save();
// 实例化模型
$user = new User;
$user->name= 'thinkphp';
$user->save();
// 或者使用助手函数`model`
$user = model('User');
$user->name= 'thinkphp';
$user->save();
模型初始化
模型初始化
模型同样支持初始化,与控制器的初始化不同的是,模型的初始化是重写Model的initialize
namespace app\index\model;
use think\Model;
class Index extends Model
{
//自定义初始化
protected function initialize()
{
//需要调用`Model`的`initialize`方法
parent::initialize();
//自定义的初始化
}
}
数据的操作
新增
添加一条数据
save方法新增数据返回的是写入的记录数。
实例化模型对象后赋值并保存
$user = new User;
$user->name = 'thinkphp';
$user->email = 'thinkphp@qq.com';
$user->save();
model助手函数用于快速实例化模型
// 使用model助手函数实例化User模型
$user = model('User');
// 模型对象赋值
$user->data([
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com'
]);
$user->save();
使用data方法批量赋值
$user = new User;
$user->data([
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com'
]);
$user->save();
实例化的时候传入数据
$user = new User([
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com'
]);
$user->save();
过滤非数据表字段的数据
$user = new User($_POST);
// 过滤post数组中的非数据表字段数据
$user->allowField(true)->save();
通过外部提交赋值给模型,并且希望指定某些字段写入
$user = new User($_POST);
// post数组中只有name和email字段会写入
$user->allowField(['name','email'])->save();
获取自增ID
获取新增数据的自增ID
$user = new User;
$user->name = 'thinkphp';
$user->email = 'thinkphp@qq.com';
$user->save();
// 获取自增ID
echo $user->id;
静态调用create方法创建
和save方法不同的是,create方法返回的是当前模型的对象实例。
$user = User::create([
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com'
]);
echo $user->name;
echo $user->email;
echo $user->id; // 获取自增ID
多次新增数据
$user = new User;
$user->name = 'thinkphp';
$user->email = 'thinkphp@qq.com';
$user->save();
$user->name = 'onethink';
$user->email = 'onethink@qq.com';
// 第二次开始必须使用下面的方式新增
$user->isUpdate(false)->save();
添加多条数据
批量新增
saveAll方法新增数据返回的是包含新增模型(带自增ID)的数据集(数组)
$user = new User;
$list = [
['name'=>'thinkphp','email'=>'thinkphp@qq.com'],
['name'=>'onethink','email'=>'onethink@qq.com']
];
$user->saveAll($list);
model助手函数用于快速实例化模型
$user = model('User');
// 批量新增
$list = [
['name'=>'thinkphp','email'=>'thinkphp@qq.com'],
['name'=>'onethink','email'=>'onethink@qq.com']
];
$user->saveAll($list);
带主键数据批量新增
saveAll 方法新增数据默认会自动识别数据是需要新增还是更新操作,当数据中存在主键的时候会认为是更新操作,如果你需要带主键数据批量新增
$user = new User;
$list = [
['id'=>1, 'name'=>'thinkphp', 'email'=>'thinkphp@qq.com'],
['id'=>2, 'name'=>'onethink', 'email'=>'onethink@qq.com'],
];
$user->saveAll($list, false);
更新
一条操作
查找并更新
$user = User::get(1);
$user->name = 'thinkphp';
$user->email = 'thinkphp@qq.com';
$user->save();
直接更新数据
$user = new User;
// save方法第二个参数为更新条件
$user->save([
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com'
],['id' => 1]);
过滤非数据表字段的数据
$user = new User();
// 过滤post数组中的非数据表字段数据
$user->allowField(true)->save($_POST,['id' => 1]);
指定某些字段写入
$user = new User();
// post数组中只有name和email字段会写入
$user->allowField(['name','email'])->save($_POST, ['id' => 1]);
批量更新数据
使用saveAll方法批量更新数据
批量更新仅能根据主键值进行更新,其它情况请使用foreach遍历更新。
$user = new User;
$list = [
['id'=>1, 'name'=>'thinkphp', 'email'=>'thinkphp@qq.com'],
['id'=>2, 'name'=>'onethink', 'email'=>'onethink@qq.com']
];
$user->saveAll($list);
强制进行数据更新操作
强制进行数据更新操作而不是新增操作(尤其适合于复合主键的情况)
$user = new User;
$list = [
['id'=>1, 'name'=>'thinkphp', 'email'=>'thinkphp@qq.com'],
['id'=>2, 'name'=>'onethink', 'email'=>'onethink@qq.com']
];
$user->isUpdate()->saveAll($list);
通过数据库类更新数据
必要的时候,你也可以使用数据库对象来直接更新数据,但这样就无法使用模型的事件功能
//如果传入update的数据包含主键的话,可以无需使用where方法。
$user = new User;
$user->where('id', 1)
->update(['name' => 'thinkphp']);
//或者使用:
$user = new User;
$user->update(['id' => 1, 'name' => 'thinkphp']);
静态方法直接更新数据
User::where('id', 1)
->update(['name' => 'thinkphp']);
//或者使用:
User::update(['id' => 1, 'name' => 'thinkphp']);
闭包更新
可以通过闭包函数使用更复杂的更新条件
$user = new User;
$user->save(['name' => 'thinkphp'],function($query){
// 更新status值为1 并且id大于10的数据
$query->where('status', 1)->where('id', '>', 10);
});
删除
删除模型数据
删除模型数据,可以在实例化后调用delete方法
$user = User::get(1);
$user->delete();
根据主键删除
$user = User::all([2, 3, 4]);
$user->delete();
//或者直接调用静态方法
User::destroy(1);
// 支持批量删除多个数据
User::destroy('1,2,3');
// 或者
User::destroy([1,2,3]);
条件删除
使用数组进行条件删除
// 删除状态为0的数据
User::destroy(['status' => 0]);
使用闭包删除
User::destroy(function($query){
$query->where('id','>',10);
});
通过数据库类的查询条件删除
User::where('id','>',10)->delete();
查询
获取单个数据
取出主键为1的数据
$user = User::get(1);
echo $user->name;
// 使用数组查询
$user = User::get(['name' => 'thinkphp']);
// 使用闭包查询
$user = User::get(function($query){
$query->where('name', 'thinkphp');
});
echo $user->name;
如果你是在模型内部,请不要使用
$this->name
的方式来获取数据,请使用$this->getAttr('name')
替代。
在实例化模型后调用查询方法
$user = new User();
// 查询单个数据
$user->where('name', 'thinkphp')
->find();
get
或者find
方法返回的是当前模型的对象实例,可以使用模型的方法。
获取多个数据
// 根据主键获取多个数据
$list = User::all('1,2,3');
// 或者使用数组
$list = User::all([1,2,3]);
foreach($list as $key=>$user){
echo $user->name;
}
// 使用数组查询
$list = User::all(['status'=>1]);
// 使用闭包查询
$list = User::all(function($query){
$query->where('status', 1)->limit(3)->order('id', 'asc');
});
foreach($list as $key=>$user){
echo $user->name;
}
数组方式和闭包方式的数据查询的区别在于,数组方式只能定义查询条件,闭包方式可以支持更多的连贯操作,包括排序、数量限制等。
在实例化模型后调用查询方法
$user = new User();
// 查询数据集
$user->where('name', 'thinkphp')
->limit(10)
->order('id', 'desc')
->select();
模型的all方法或者select方法返回的是一个包含模型对象的二维数组或者数据集对象。
获取某个字段或者某个列的值
// 获取某个用户的积分
User::where('id',10)->value('score');
// 获取某个列的所有值
User::where('status',1)->column('name');
// 以id为索引
User::where('status',1)->column('name','id');
User::where('status',1)->column('id,name'); // 同tp3的getField
注意
value
和column
方法返回的不再是一个模型对象实例,而是单纯的值或者某个列的数组。
动态查询
// 根据name字段查询用户
$user = User::getByName('thinkphp');
// 根据email字段查询用户
$user = User::getByEmail('thinkphp@qq.com');
使用数据库的查询方法进行更复杂的查询
//可以在模型中直接使用所有数据库的链式操作方法。
User::where('id','>',10)->select();
User::where('name','thinkphp')->find();
获取器
获取器的作用
获取器的作用是在获取数据的字段值后自动进行处理
//写在模型模块内容下
class User extends Model
{
public function getStatusAttr($value)
{
$status = [-1=>'删除',0=>'禁用',1=>'正常',2=>'待审核'];
return $status[$value];
}
}
//数据表的字段会自动转换为驼峰法,一般status字段的值采用数值类型
//写在控制器下对应的文件内
$user = User::get(1);
echo $user->status; // 例如输出“正常”
获取器还可以定义数据表中不存在的字段
//获取器方法的第二个参数($data)传入的是当前的所有数据数组。
//写在模型模块内容下
protected $append = [
'status_text'
];
public function getStatusTextAttr($value, $data)
{
$key = $data['status'];
$status = [-1 => '删除', 0 => '禁用', 1 => '正常', 2 => '待审核'];
return $status[$key];
dump($data);
}
修改器
修改器的作用
修改器的作用是可以在数据赋值的时候自动进行转换处理
//写在模型模块内容下
//保存到数据库中的时候会自动转化数据为小写
class User extends Model
{
public function setNameAttr($value)
{
return strtolower($value);
}
}
//写在控制器下对应的文件内
//实际保存到数据库中的时候会转为小写
$user = new User();
$user->name = 'THINKPHP';
$user->save();
echo $user->name; // thinkphp
批量修改
直接使用save方法触发
$user = new User();
$data['name'] = 'THINKPHP';
$data['email'] = 'thinkphp@qq.com';
$user->save($data);
echo $user->name; // thinkphp
软删除
软删除的作用就是把数据加上删除标记,而不是真正的删除,同时也便于需要的时候进行数据的恢复。
如何使用软删除
deleteTime
属性用于定义你的软删除标记字段,ThinkPHP5的软删除功能使用时间戳类型(数据表默认值为Null
,数据类型为int
),用于记录数据的删除时间。
//写在模型模块内容下
namespace app\index\model;
use think\Model;
use traits\model\SoftDelete;
class User extends Model
{
use SoftDelete;
protected $deleteTime = 'delete_time';
}
//写在控制器下对应的文件内
// 软删除
User::destroy(1);
// 真实删除
User::destroy(1,true);
$user = User::get(1);
// 软删除
$user->delete();
// 真实删除
$user->delete(true);
JSON序列化
调用模型的toJson方法进行JSON序列化
$user = User::get(1);
echo $user->toJson();
设置无需输出的字段
$user = User::get(1);
echo $user->hidden(['create_time','update_time'])->toJson();
追加其它的字段
$user = User::get(1);
echo $user->append(['status_text'])->toJson();
允许输出的属性
$user = User::get(1);
echo $user->visible(['id','name','email'])->toJson();
模型对象可以直接被JSON序列化
echo json_encode(User::get(1));
//或者也可以直接echo 一个模型对象
echo User::get(1);
//输出结果类似于:
{"id":"1","name":"","title":"","status":"1","update_time":"1430409600","score":"90.5"}