攏簍7攏漏鹿脴脕陋 · tp5文檔

本篇為您講述ThinkPHP5.0的關聯定義和基礎用法，主要包括： - - [基本定義](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u57FAu672Cu5B9Au4E49) - [一對一關聯](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u4E00u5BF9u4E00u5173u8054) - [關聯定義](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u5B9Au4E49) - [關聯寫入](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u5199u5165) - [關聯查詢](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u67E5u8BE2) - [關聯更新](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u66F4u65B0) - [關聯刪除](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u5220u9664) - [一對多關聯](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u4E00u5BF9u591Au5173u8054) - [關聯定義](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u5B9Au4E49-1) - [關聯新增](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u65B0u589E) - [關聯查詢](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u67E5u8BE2-1) - [關聯更新](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u66F4u65B0-1) - [關聯刪除](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u5220u9664-1) - [多對多關聯](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u591Au5BF9u591Au5173u8054) - [關聯定義](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u5B9Au4E49-2) - [關聯新增](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u65B0u589E-1) - [關聯刪除](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u5220u9664-2) - [關聯查詢](http://www.hmoore.net/thinkphp/thinkphp5_quickstart/145257#u5173u8054u67E5u8BE2-2) ## 基本定義 `ThinkPHP5.0`的關聯采用了對象化的操作模式，你無需繼承不同的模型類，只是把關聯定義成一個方法，并且直接通過當前模型對象的屬性名獲取定義的關聯數據。舉個例子，有一個用戶模型`User`，有一個關聯的模型對象`Book`，每個用戶有多本書，`User`模型定義如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\model; use think\Model; class User extends Model{ // 定義關聯方法public function books(){ return $this->hasMany('Book'); } } ``` ``` > #### 提示： > > - - - - - - > > `User`模型的`books`方法就是一個關聯定義方法，方法名可以隨意命名，但注意要避免和`User`模型對象的字段屬性沖突。實際獲取關聯數據的時候，就是采用下面的方式： ``` <pre class="calibre18"> ``` $user = User::get(5); // 獲取User對象的nickname屬性echo $user->nickname; // 獲取User對象的Book關聯對象 dump($user->books); // 執行關聯的Book對象的查詢$user->books()->where('name','thinkphp')->find(); ``` ``` 對于涉及的代碼用法，目前不用深究，后面會詳細描述。一般來說，關聯關系包括： - 一對一關聯：`HAS_ONE` 以及相對的 `BELONGS_TO` - 一對多關聯：`HAS_MANY` 以及相對的 `BELONGS_TO` - 多對多關聯：`BELONGS_TO_MANY` 后面會詳細講解每一種關聯的用法。 ## 一對一關聯一對一關聯是一種最簡單的關聯，例如每個用戶都有一份檔案，每個公司都有一個營業執照等等。在這之前，我們先創建數據表如下： ``` <pre class="calibre18"> ``` DROP TABLE IF EXISTS `think_user`; CREATE TABLE IF NOT EXISTS `think_user` ( `id` int(6) UNSIGNED NOT NULL AUTO_INCREMENT, `nickname` varchar(25) NOT NULL, `name` varchar(25) NOT NULL, `password` varchar(50) NOT NULL, `create_time` int(11) UNSIGNED NOT NULL, `update_time` int(11) UNSIGNED NOT NULL, `status` tinyint(1) DEFAULT 0, PRIMARY KEY (`id`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8; DROP TABLE IF EXISTS `think_profile`; CREATE TABLE IF NOT EXISTS `think_profile` ( `id` int(6) UNSIGNED NOT NULL AUTO_INCREMENT, `truename` varchar(25) NOT NULL, `birthday` int(11) NOT NULL, `address` varchar(255) DEFAULT NULL, `email` varchar(255) DEFAULT NULL, `user_id` int(6) UNSIGNED NOT NULL, PRIMARY KEY (`id`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8; ``` ``` ### 關聯定義我們以用戶和檔案的一對一關聯為例，在`User`模型類中添加關聯定義方法，然后在方法中調用`hasOne`方法即可： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\model; use think\Model; class User extends Model{ // 開啟自動寫入時間戳protected $autoWriteTimestamp = true; // 定義自動完成的屬性protected $insert = ['status' => 1]; // 定義關聯方法public function profile(){ // 用戶HAS ONE檔案關聯return $this->hasOne('Profile'); } } ``` ``` hasOne方法有5個參數，依次分別是： > #### hasOne('關聯模型名','關聯外鍵','主鍵','別名定義','join類型') 默認的外鍵是：**當前模型名\_id**，主鍵則是自動獲取，如果你的表設計符合這一規范的話，只需要設置關聯的模型名即可. 通常關聯模型和當前模型都是相同的命名空間，如果關聯模型在不同的命名空間，需要指定完整的類名，例如： ``` <pre class="calibre18"> ``` // 關聯admin模塊下面的模型對象return $this->hasOne('\app\admin\Profile'); ``` ``` 在關聯查詢的時候，默認使用當前模型的名稱（小寫）作為數據表別名，可以指定查詢使用的數據表別名，例如： ``` <pre class="calibre18"> ``` // 用戶HAS ONE檔案關聯return $this->hasOne('Profile','user_id','id',['user'=>'member','profile'=>'info']); ``` ``` 要進行模型的關聯操作，我們必須同時定義好關聯模型，`Profile`模型定義如下： ``` <pre class="calibre18"> ``` <?php namespace app\index\model; use think\Model; class Profile extends Model{ protected $type = [ 'birthday' => 'timestamp:Y-m-d', ]; } ``` ``` 可以看到`Profile`模型中并沒有定義關聯方法。如果你的關聯操作都是基于`User`模型的話，`Profile`模型中并不需要定義關聯方法。如果你需要基于`Profile`模型來進行關聯操作，則需要在`Profile`模型中定義對應的`BELONGS_TO`關聯，如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\model; use think\Model; class Profile extends Model{ protected $type = [ 'birthday' => 'timestamp:Y-m-d', ]; public function user(){ // 檔案 BELONGS TO 關聯用戶return $this->belongsTo('User'); } } ``` ``` `belongsTo`方法和`hasOne`一樣，也有5個參數： > #### belongsTo('關聯模型名','關聯外鍵','關聯模型主鍵','別名定義','join類型') ### 關聯寫入首先來看下如何進行關聯數據的寫入，創建User控制器的add操作方法如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use app\index\model\Profile; use app\index\model\User as UserModel; class User{ // 關聯新增數據public function add(){ $user = new UserModel; $user->name = 'thinkphp'; $user->password = '123456'; $user->nickname = '流年'; if ($user->save()) { // 寫入關聯數據$profile = new Profile; $profile->truename = '劉晨'; $profile->birthday = '1977-03-05'; $profile->address = '中國上海'; $profile->email = 'thinkphp@qq.com'; $user->profile()->save($profile); return '用戶新增成功'; } else { return $user->getError(); } } } ``` ``` 關聯模型的寫入調用了關聯方法`profile()`，該方法返回的是一個`Relation`對象，執行`save`方法會自動傳入當前模型`User`的主鍵作為關聯鍵值，所以不需要手動傳入`Profile`模型的`user_id`屬性。 `save`方法也可以直接使用數組而不是`Profile`對象，例如： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\controller; use app\index\model\Profile; use app\index\model\User as UserModel; class User extends Controller{ // 關聯新增數據public function add(){ $user = new UserModel; $user->name = 'thinkphp'; $user->password = '123456'; $user->nickname = '流年'; if ($user->save()) { // 寫入關聯數據$profile['truename'] = '劉晨'; $profile['birthday'] = '1977-03-05'; $profile['address'] = '中國上海'; $profile['email'] = 'thinkphp@qq.com'; $user->profile()->save($profile); return '用戶[ ' . $user->name . ' ]新增成功'; } else { return $user->getError(); } } } ``` ``` ### 關聯查詢一對一的關聯查詢很簡單，直接把關聯對象當成屬性來用即可，例如： ``` <pre class="calibre18"> ``` public function read($id){ $user = UserModel::get($id); echo $user->name . ' '; echo $user->nickname . ' '; echo $user->profile->truename . ' '; echo $user->profile->email . ' '; } ``` ``` 訪問URL地址： ``` <pre class="calibre18"> ``` http: //tp5.com/user/1 ``` ``` 最后輸出結果為： ``` <pre class="calibre18"> ``` thinkphp 流年劉晨 thinkphp@qq.com ``` ``` 以上關聯查詢的時候，只有在獲取關聯對象（`$user->profile`）的時候才會進行實際的關聯查詢，缺點是會可能進行多次查詢，但可以使用預載入查詢來提高查詢性能，對于一對一關聯來說，只需要進行一次查詢即可獲取關聯對象數據，例如： ``` <pre class="calibre18"> ``` public function read($id){ $user = UserModel::get($id,'profile'); echo $user->name . ' '; echo $user->nickname . ' '; echo $user->profile->truename . ' '; echo $user->profile->email . ' '; } ``` ``` get方法使用第二個參數就表示進行關聯預載入查詢。 ### 關聯更新一對一的關聯更新如下： ``` <pre class="calibre18"> ``` public function update($id){ $user = UserModel::get($id); $user->name = 'framework'; if ($user->save()) { // 更新關聯數據$user->profile->email = 'liu21st@gmail.com'; $user->profile->save(); return '用戶[ ' . $user->name . ' ]更新成功'; } else { return $user->getError(); } } ``` ``` 訪問URL地址： ``` <pre class="calibre18"> ``` http: //tp5.com/user/update/1 ``` ``` 最后輸出結果為： ``` <pre class="calibre18"> ``` 用戶更新成 ``` ``` ### 關聯刪除關聯刪除代碼如下： ``` <pre class="calibre18"> ``` public function delete($id){ $user = UserModel::get($id); if ($user->delete()) { // 刪除關聯數據$user->profile->delete(); return '用戶[ ' . $user->name . ' ]刪除成功'; } else { return $user->getError(); } } ``` ``` 訪問URL地址： ``` <pre class="calibre18"> ``` http: //tp5.com/user/delete/1 ``` ``` 頁面輸出結果為： ``` <pre class="calibre18"> ``` 用戶刪除成功 ``` ``` ## 一對多關聯每個作者寫有多本書就是一個典型的一對多關聯，首先創建如下數據表： ``` <pre class="calibre18"> ``` DROP TABLE IF EXISTS `think_book`; CREATE TABLE IF NOT EXISTS `think_book` ( `id` int(8) UNSIGNED NOT NULL AUTO_INCREMENT, `title` varchar(255) NOT NULL, `publish_time` int(11) UNSIGNED DEFAULT NULL, `create_time` int(11) UNSIGNED NOT NULL, `update_time` int(11) UNSIGNED NOT NULL, `status` tinyint(1) NOT NULL, `user_id` int(6) UNSIGNED NOT NULL, PRIMARY KEY (`id`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8; ``` ``` ### 關聯定義在`User`模型類添加`Book`關聯如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\model; use think\Model; class User extends Model{ // 開啟自動寫入時間戳protected $autoWriteTimestamp = true; // 定義自動完成的屬性protected $insert = ['status' => 1]; // 定義關聯方法public function profile(){ return $this->hasOne('Profile'); } // 定義關聯public function books(){ return $this->hasMany('Book'); } } ``` ``` `hasMany`的參數如下： > #### hasMany('關聯模型名','關聯外鍵','關聯模型主鍵','別名定義') `Book`模型類定義如下： ``` <pre class="calibre18"> ``` <?php namespace app\index\model; use think\Model; class Book extends Model{ protected $type = [ 'publish_time' => 'timestamp:Y-m-d', ]; // 開啟自動寫入時間戳protected $autoWriteTimestamp = true; // 定義自動完成的屬性protected $insert = ['status' => 1]; } ``` ``` 如果需要定義對應的關聯，則可以使用`belongsTo`方法： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\model; use think\Model; class Book extends Model{ protected $type = [ 'publish_time' => 'timestamp:Y-m-d', ]; // 開啟自動寫入時間戳protected $autoWriteTimestamp = true; // 定義自動完成的屬性protected $insert = ['status' => 1]; // 定義關聯方法public function user(){ return $this->belongsTo('User'); } } ``` ``` ### 關聯新增添加`addBook`方法用于新增關聯數據： ``` <pre class="calibre18"> ``` public function addBook(){ $user = UserModel::get(1); $book = new Book; $book->title = 'ThinkPHP5快速入門'; $book->publish_time = '2016-05-06'; $user->books()->save($book); return '添加Book成功'; } ``` ``` 對于一對多關聯，也可以批量增加數據： ``` <pre class="calibre18"> ``` public function addBook(){ $user = UserModel::get(1); $books = [ ['title' => 'ThinkPHP5快速入門', 'publish_time' => '2016-05-06'], ['title' => 'ThinkPHP5開發手冊', 'publish_time' => '2016-03-06'], ]; $user->books()->saveAll($books); return '添加Book成功'; } ``` ``` ### 關聯查詢可以直接調用模型的屬性獲取全部關聯數據，例如： ``` <pre class="calibre18"> ``` public function read(){ $user = UserModel::get(1); $books = $user->books; dump($books); } ``` ``` 一對多查詢同樣可以使用預載入查詢，例如： ``` <pre class="calibre18"> ``` public function read(){ $user = UserModel::get(1,'books'); $books = $user->books; dump($books); } ``` ``` 一對多預載入查詢會在原先延遲查詢的基礎上增加一次查詢，可以解決典型的`N+1`次查詢問題。如果要過濾查詢，可以調用關聯方法： ``` <pre class="calibre18"> ``` public function read(){ $user = UserModel::get(1); // 獲取狀態為1的關聯數據$books = $user->books()->where('status',1)->select(); dump($books); // 獲取作者寫的某本書$book = $user->books()->getByTitle('ThinkPHP5快速入門'); dump($book); } ``` ``` 還可以根據關聯數據來查詢當前模型數據，例如： ``` <pre class="calibre18"> ``` public function read(){ // 查詢有寫過書的作者列表$user = UserModel::has('books')->select(); // 查詢寫過三本書以上的作者$user = UserModel::has('books', '>=', 3)->select(); // 查詢寫過ThinkPHP5快速入門的作者$user = UserModel::hasWhere('books', ['title' => 'ThinkPHP5快速入門'])->select(); } ``` ``` ### 關聯更新下面來進行關聯數據的更新 ``` <pre class="calibre18"> ``` public function update($id){ $user = UserModel::get($id); $book = $user->books()->getByTitle('ThinkPHP5開發手冊'); $book->title = 'ThinkPHP5快速入門'; $book->save(); } ``` ``` 或者使用查詢構建器的`update`方法進行更新（但可能無法觸發關聯模型的事件）。 ``` <pre class="calibre18"> ``` public function update($id){ $user = UserModel::get($id); $user->books()->where('title', 'ThinkPHP5快速入門')->update(['title' => 'ThinkPHP5開發手冊']); } ``` ``` ### 關聯刪除刪除部分關聯數據： ``` <pre class="calibre18"> ``` public function delete($id){ $user = UserModel::get($id); // 刪除部分關聯數據$book = $user->books()->getByTitle('ThinkPHP5開發手冊'); $book->delete(); } ``` ``` 刪除所有的關聯數據： ``` <pre class="calibre18"> ``` public function delete($id){ $user = UserModel::get($id); if($user->delete()){ // 刪除所有的關聯數據$user->books()->delete(); } } ``` ``` ## 多對多關聯一個用戶會有多個角色，同時一個角色也會包含多個用戶，這就是一個典型的多對多關聯，先創建一個角色表`think_role`結構如下： ``` <pre class="calibre18"> ``` DROP TABLE IF EXISTS `think_role`; CREATE TABLE IF NOT EXISTS `think_role` ( `id` int(5) UNSIGNED NOT NULL AUTO_INCREMENT, `name` varchar(25) NOT NULL, `title` varchar(50) NOT NULL, PRIMARY KEY (`id`) ) ENGINE=MyISAM DEFAULT CHARSET=utf8; ``` ``` 多對多關聯通常一定會有一個中間表，也稱為樞紐表，所以需要創建一個用戶角色的中間表，這里創建了一個`think_access`表，結構如下： ``` <pre class="calibre18"> ``` DROP TABLE IF EXISTS `think_access`; CREATE TABLE IF NOT EXISTS `think_access` ( `user_id` int(6) UNSIGNED NOT NULL, `role_id` int(5) UNSIGNED NOT NULL ) ENGINE=MyISAM DEFAULT CHARSET=utf8; ``` ``` ### 關聯定義給User模型添加多對多關聯方法定義 ``` <pre class="calibre18"> ``` <?phpnamespace app\index\model; use think\Model; class User extends Model{ // 開啟自動寫入時間戳protected $autoWriteTimestamp = true; // 定義自動完成的屬性protected $insert = ['status' => 1]; // 定義一對一關聯public function profile(){ return $this->hasOne('Profile'); } // 定義一對多關聯public function books(){ return $this->hasMany('Book'); } // 定義多對多關聯public function roles(){ // 用戶 BELONGS_TO_MANY 角色return $this->belongsToMany('Role', 'think_access'); } } ``` ``` `belongsToMany`的參數如下： > #### belongsToMany('關聯模型名','中間表名稱','關聯外鍵','關聯模型主鍵','別名定義') `Role`模型定義如下： ``` <pre class="calibre18"> ``` <?phpnamespace app\index\model; use think\Model; class Role extends Model{ public function user(){ // 角色 BELONGS_TO_MANY 用戶return $this->belongsToMany('User', 'think_access'); } } ``` ``` 對于樞紐表并不需要創建模型類，在多對多關聯關系中，并不需要直接操作樞紐表。 ### 關聯新增給某個用戶增加編輯角色，并且由于這個角色還沒創建過，所以可以使用下面的方式： ``` <pre class="calibre18"> ``` // 關聯新增數據public function add(){ $user = UserModel::getByNickname('張三'); // 新增用戶角色并自動寫入樞紐表$user->roles()->save(['name' => 'editor', 'title' => '編輯']); return '用戶角色新增成功'; } ``` ``` 也可以批量新增用戶的角色如下： ``` <pre class="calibre18"> ``` // 關聯新增數據public function add(){ $user = UserModel::getByNickname('張三'); // 給當前用戶新增多個用戶角色$user->roles()->saveAll([ ['name' => 'leader', 'title' => '領導'], ['name' => 'admin', 'title' => '管理員'], ]); return '用戶角色新增成功'; } ``` ``` 現在給另外一個用戶增加編輯角色，由于該角色已經存在了，所以只需要使用`attach`方法增加樞紐表的關聯數據： ``` <pre class="calibre18"> ``` // 關聯新增數據public function add(){ $user = UserModel::getByNickname('張三'); $role = Role::getByName('editor'); // 添加樞紐表數據$user->roles()->attach($role); return '用戶角色添加成功'; } ``` ``` 或者直接使用角色Id添加關聯數據 ``` <pre class="calibre18"> ``` // 關聯新增數據public function add(){ $user = UserModel::getByNickname('張三'); $user->roles()->attach(1); return '用戶角色添加成功'; } ``` ``` ### 關聯刪除如果需要解除用戶的管理角色，可以使用`detach`方法刪除關聯的樞紐表數據，但不會刪除關聯模型數據，例如： ``` <pre class="calibre18"> ``` // 關聯刪除數據public function delete(){ $user = UserModel::get(2); $role = Role::getByName('admin'); // 刪除關聯數據但不刪除關聯模型數據$user->roles()->detach($role); return '用戶角色刪除成功'; } ``` ``` 如果有必要，也可以刪除樞紐表的同時刪除關聯模型，下面的例子會解除用戶的編輯角色并且同時刪除編輯這個角色身份： ``` <pre class="calibre18"> ``` // 關聯刪除數據public function delete(){ $user = UserModel::getByNickname('張三'); $role = Role::getByName('editor'); // 刪除關聯數據并同時刪除關聯模型數據$user->roles()->detach($role,true); return '用戶角色刪除成功'; } ``` ``` ### 關聯查詢獲取用戶張三的所有角色的話，直接使用： ``` <pre class="calibre18"> ``` // 關聯查詢public function read(){ $user = UserModel::getByNickname('張三'); dump($user->roles); } ``` ``` 同樣支持對多對多關聯使用預載入查詢： ``` <pre class="calibre18"> ``` // 關聯查詢public function read(){ // 預載入查詢$user = UserModel::get(2,'roles'); dump($user->roles); } ``` ``` 到目前為止，我們已經掌握了關聯的基礎用法，更多的關聯使用請關注后續相關的專題。