一对一关联
一对一关联
版本 | 新增功能 |
---|---|
5.1.2 | 增加selfRelation 方法定义当前关联为自关联 |
关联定义
定义一对一关联,例如,一个用户都有一个个人资料,我们定义User
模型如下:
<?php
namespace app\index\model;
use think\Model;
class User extends Model
{
public function profile()
{
return $this->hasOne('Profile');
}
}
hasOne
方法的参数包括:
hasOne('关联模型','外键','主键');
除了关联模型外,其它参数都是可选。
- 关联模型(必须):关联的模型名或者类名
- 外键:默认的外键规则是当前模型名(不含命名空间,下同)+
_id
,例如user_id
- 主键:当前模型主键,默认会自动获取也可以指定传入
一对一关联定义的时候还支持额外的方法,包括:
方法名 | 描述 |
---|---|
setEagerlyType | 定义关联查询方式,0 - JOIN 查询 1 - IN 查询(默认) |
bind | 绑定关联属性到父模型 |
joinType | JOIN方式查询的JOIN方式,默认为INNER |
selfRelation | 定义当前关联为自关联 |
如果使用了JOIN方式的关联查询方式,你可以在额外的查询条件中使用关联方法名作为表的别名。
关联查询
定义好关联之后,就可以使用下面的方法获取关联数据:
$user = User::get(1);
// 输出Profile关联模型的email属性
echo $user->profile->email;
默认情况下, 我们使用的是user_id
作为外键关联,如果不是的话则需要在关联定义的时候指定,例如:
<?php
namespace app\index\model;
use think\Model;
class User extends Model
{
public function profile()
{
return $this->hasOne('Profile','uid');
}
}
有一点需要注意的是,关联方法的命名规范是驼峰法,而关联属性则一般是小写+下划线的方式,系统在获取的时候会自动转换对应,读取
user_profile
关联属性则对应的关联方法应该是userProfile
。
关联保存
$user = User::get(1);
// 如果还没有关联数据 则进行新增
$user->profile()->save(['email' => 'thinkphp']);
系统会自动把当前模型的主键传入Profile
模型。
和新增一样使用save
方法进行更新关联数据。
$user = User::get(1);
$user->profile->email = 'thinkphp';
$user->profile->save();
// 或者
$user->profile->save(['email' => 'thinkphp']);
定义相对关联
我们可以在Profile
模型中定义一个相对的关联关系,例如:
<?php
namespace app\index\model;
use think\Model;
class Profile extends Model
{
public function user()
{
return $this->belongsTo('User');
}
}
belongsTo
的参数包括:
belongsTo('关联模型','外键','关联主键');
除了关联模型外,其它参数都是可选。
- 关联模型(必须):模型名或者模型类名
- 外键:当前模型外键,默认的外键名规则是关联模型名+
_id
- 关联主键:关联模型主键,一般会自动获取也可以指定传入
默认的关联外键是user_id
,如果不是,需要在第二个参数定义
<?php
namespace app\index\model;
use think\Model;
class Profile extends Model
{
public function user()
{
return $this->belongsTo('User','uid');
}
}
我们就可以根据档案资料来获取用户模型的信息
$profile = Profile::get(1);
// 输出User关联模型的属性
echo $profile->user->account;
绑定属性到父模型
可以在定义关联的时候使用bind
方法绑定属性到父模型,例如:
<?php
namespace app\index\model;
use think\Model;
class User extends Model
{
public function profile()
{
return $this->hasOne('Profile','uid')->bind('nickname,email');
}
}
或者使用数组的方式指定绑定属性别名
<?php
namespace app\index\model;
use think\Model;
class User extends Model
{
public function profile()
{
return $this->hasOne('Profile','uid')->bind([
'email',
'truename' => 'nickname',
'profile_id' => 'id',
]);
}
}
然后使用关联预载入查询的时候,可以使用
$user = User::get(1,'profile');
// 输出Profile关联模型的email属性
echo $user->email;
echo $user->profile_id;
绑定关联模型的属性支持读取器。
如果不是预载入查询,请使用模型的
appendRelationAttr
方法追加属性。
关联自动写入
我们可以使用together
方法更方便的进行关联自动写入操作。
写入
$blog = new Blog;
$blog->name = 'thinkphp';
$blog->title = 'ThinkPHP5关联实例';
$content = new Content;
$content->data = '实例内容';
$blog->content = $content;
$blog->together('content')->save();
如果绑定了子模型的属性到当前模型,可以用数组指定子模型的属性
$blog = new Blog;
$blog->name = 'thinkphp';
$blog->title = 'ThinkPHP5关联实例';
$blog->content = '实例内容';
// title和content是子模型的属性
$blog->together(['content'=>['title','content']])->save();
更新
// 查询
$blog = Blog::get(1);
$blog->title = '更改标题';
$blog->content->data = '更新内容';
// 更新当前模型及关联模型
$blog->together('content')->save();
删除
// 查询
$blog = Blog::get(1,'content');
// 删除当前及关联模型
$blog->together('content')->delete();
如果不想这么麻烦每次调用
together
方法,也可以直接在模型类中定义relationWrite
属性,但必须是数组方式。不过考虑到模型的独立操作的可能性,并不建议。