定义一对一关联,例如,一个用户都有一个个人资料,我们定义User
模型如下:
<?phpnamespace app\model;use think\Model;class User extends Model{ public function profile() { return $this->hasOne(Profile::class); }}
hasOne
方法的参数包括:
hasOne('关联模型类名', '外键', '主键');
除了关联模型外,其它参数都是可选。
_id
,例如user_id
一对一关联定义的时候还支持额外的方法,包括:
方法名 | 描述 |
---|---|
bind | 绑定关联属性到父模型 |
joinType | JOIN方式查询的JOIN方式,默认为INNER |
如果使用了JOIN方式的关联查询方式,你可以在额外的查询条件中使用关联对象名(不含命名空间)作为表的别名。
定义好关联之后,就可以使用下面的方法获取关联数据:
$user = User::find(1);// 输出Profile关联模型的email属性echo $user->profile->email;
默认情况下, 我们使用的是user_id
作为外键关联,如果不是的话则需要在关联定义的时候指定,例如:
<?phpnamespace app\model;use think\Model;class User extends Model{ public function profile() { return $this->hasOne(Profile::class, 'uid'); }}
有一点需要注意的是,关联方法的命名规范是驼峰法,而关联属性则一般是小写+下划线的方式,系统在获取的时候会自动转换对应,读取
user_profile
关联属性则对应的关联方法应该是userProfile
。
可以根据关联条件来查询当前模型对象数据,例如:
// 查询用户昵称是think的用户// 注意第一个参数是关联方法名(不是关联模型名)$users = User::hasWhere('profile', ['nickname'=>'think'])->select();// 可以使用闭包查询$users = User::hasWhere('profile', function(Query $query) { $query->where('nickname', 'like', 'think%');})->select();
可以使用预载入查询解决典型的N+1
查询问题,使用:
$users = User::with('profile')->select();foreach ($users as $user) { echo $user->profile->name;}
上面的代码使用的是IN
查询,只会产生2条SQL查询。
如果要对关联模型进行约束,可以使用闭包的方式。
$users = User::with(['profile' => function(Query $query) { $query->field('id,user_id,name,email');}])->select();foreach ($users as $user) { echo $user->profile->name;}
with
方法可以传入数组,表示同时对多个关联模型(支持不同的关联类型)进行预载入查询。
$users = User::with(['profile','book'])->select();foreach ($users as $user) { echo $user->profile->name; foreach($user->book as $book) { echo $book->name; }}
如果需要使用JOIN
方式的查询,直接使用withJoin
方法,如下:
$users = User::withJoin('profile')->select();foreach ($users as $user) { echo $user->profile->name;}
withJoin
方法默认使用的是INNER JOIN
方式,如果需要使用其它的,可以改成
$users = User::withJoin('profile', 'LEFT')->select();foreach ($users as $user) { echo $user->profile->name;}
需要注意的是withJoin
方式不支持嵌套关联,通常你可以直接传入多个需要关联的模型。
如果需要约束关联字段,可以使用下面的简便方法。
$users = User::withJoin([ 'profile' => ['user_id', 'name', 'email']])->select();foreach ($users as $user) { echo $user->profile->name;}
特别注意的是 withJoin
不支持通过 alias
方法指定别名。因此如果你需要指定别名查询的时候,ORM 会自动设定别名。比如我们有表 user
和表 user_profile
,我们也分别定义了 模型 User
和 模型 UserProfile
,在通过如下的查询时:
$users = User::withJoin([ 'profile' => function (Query $query) { $query->where('profile.is_delete', 1); }])->where('user.is_delete', 1)->select();
我们就可以通过,模型名的小写来指定别名,比如 模型名叫 User
则别名为 user
, 模型名叫 UserData
则别名为 user_data
。
而通过 withJoin
关联的表的别名,就是 我们在使用 withJoin
的时候指定的key,比如本例子就是 profile
。
$user = User::find(1);// 如果还没有关联数据 则进行新增$user->profile()->save(['email' => 'thinkphp']);
系统会自动把当前模型的主键传入Profile
模型。
和新增一样使用save
方法进行更新关联数据。
$user = User::find(1);$user->profile->email = 'thinkphp';$user->profile->save();// 或者$user->profile->save(['email' => 'thinkphp']);
我们可以在Profile
模型中定义一个相对的关联关系,例如:
<?phpnamespace app\model;use think\Model;class Profile extends Model{ public function user() { return $this->belongsTo(User::class); }}
belongsTo
的参数包括:
belongsTo('关联模型','外键', '关联主键');
除了关联模型外,其它参数都是可选。
_id
默认的关联外键是user_id
,如果不是,需要在第二个参数定义
<?phpnamespace app\model;use think\Model;class Profile extends Model{ public function user() { return $this->belongsTo(User::class, 'uid'); }}
我们就可以根据档案资料来获取用户模型的信息
$profile = Profile::find(1);// 输出User关联模型的属性echo $profile->user->account;
可以在定义关联的时候使用bind
方法绑定属性到父模型,例如:
<?phpnamespace app\model;use think\Model;class User extends Model{ public function profile() { return $this->hasOne(Profile::class, 'uid')->bind(['nickname', 'email']); }}
或者指定绑定属性别名
<?phpnamespace app\model;use think\Model;class User extends Model{ public function profile() { return $this->hasOne(Profile::class, 'uid')->bind([ 'email', 'truename' => 'nickname', ]); }}
然后使用关联预载入查询的时候,可以使用
$user = User::with('profile')->find(1);// 直接输出Profile关联模型的绑定属性echo $user->email;echo $user->truename;
绑定关联模型的属性支持读取器。
如果不是预载入查询,请使用模型的
appendRelationAttr
方法追加属性。
也可以使用动态绑定关联属性,可以使用
$user = User::find(1)->bindAttr('profile',['email','nickname']);// 输出Profile关联模型的email属性echo $user->email;echo $user->nickname;
同样支持指定属性别名
$user = User::find(1)->bindAttr('profile',[ 'email', 'truename' => 'nickname',]);// 输出Profile关联模型的email属性echo $user->email;echo $user->truename;
我们可以使用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::find(1);$blog->title = '更改标题';$blog->content->data = '更新内容';// 更新当前模型及关联模型$blog->together(['content'])->save();
删除
// 查询$blog = Blog::with('content')->find(1);// 删除当前及关联模型$blog->together(['content'])->delete();