關系類型 · October Cms 筆記

### [](https://octobercms.com/docs/database/relations#one-to-one)一對一一對一關系是非常基本的關系。例如，`User`模型可能與關聯`Phone`。為了定義這種關系，我們向模型`phone`的`$hasOne`屬性添加一個條目`User`。 ~~~ <?php namespace Acme\Blog\Models; use Model; class User extends Model { public $hasOne = [ 'phone' => 'Acme\Blog\Models\Phone' ]; } ~~~ 定義關系后，我們可以使用相同名稱的model屬性檢索相關記錄。這些屬性是動態的，使您可以像訪問模型中的常規屬性一樣訪問它們： ~~~ $phone = User::find(1)->phone; ~~~ 模型基于模型名稱假定關系的外鍵。在這種情況下，將`Phone`自動假定模型具有`user_id`外鍵。如果您希望覆蓋此約定，則可以將`key`參數傳遞給定義： ~~~ public $hasOne = [ 'phone' => ['Acme\Blog\Models\Phone', 'key' => 'my_user_id'] ]; ~~~ 此外，該模型還假定外鍵的值應`id`與父級的列匹配。換句話說，它將在記錄的`id`列中查找用戶列的值。如果您希望該關系使用以外的值，則可以將參數傳遞給定義：`user_id``Phone``id``otherKey` ~~~ public $hasOne = [ 'phone' => ['Acme\Blog\Models\Phone', 'key' => 'my_user_id', 'otherKey' => 'my_id'] ]; ~~~ #### 定義關系的逆關系現在，我們可以從中訪問`Phone`模型了`User`。讓我們做相反的事情，并在`Phone`模型上定義一個關系，使我們可以訪問`User`擁有手機的。我們可以`hasOne`使用`$belongsTo`屬性定義關系的逆： ~~~ class Phone extends Model { public $belongsTo = [ 'user' => 'Acme\Blog\Models\User' ]; } ~~~ 在上面的例子中，模型將嘗試匹配的`user_id`從`Phone`模型到一個`id`上`User`的模型。它通過檢查關系定義的名稱并在名稱后綴來確定默認的外鍵名稱`_id`。但是，如果`Phone`模型上的外鍵不是`user_id`，則可以使用`key`定義中的參數傳遞自定義鍵名稱： ~~~ public $belongsTo = [ 'user' => ['Acme\Blog\Models\User', 'key' => 'my_user_id'] ]; ~~~ 如果您的父模型不用`id`作其主鍵，或者您希望將子模型連接到其他列，則可以將`otherKey`參數傳遞給指定父表的自定義鍵的定義： ~~~ public $belongsTo = [ 'user' => ['Acme\Blog\Models\User', 'key' => 'my_user_id', 'otherKey' => 'my_id'] ]; ~~~ #### 默認型號的`belongsTo`關系，您可以定義如果給定的關系是將要返回默認模式`null`。此模式通常稱為[空對象模式](https://en.wikipedia.org/wiki/Null_Object_pattern)，可以幫助刪除代碼中的條件檢查。在以下示例中，如果該帖子未附加，則該`user`關系將返回一個空`Acme\Blog\Models\User`模型`user`： ~~~ public $belongsTo = [ 'user' => ['Acme\Blog\Models\User', 'default' => true] ]; ~~~ 要使用屬性填充默認模型，可以將數組傳遞給`default`參數： ~~~ public $belongsTo = [ 'user' => [ 'Acme\Blog\Models\User', 'default' => ['name' => 'Guest'] ] ]; ~~~ ### [](https://octobercms.com/docs/database/relations#one-to-many)一對多一對多關系用于定義單個模型擁有任意數量其他模型的關系。例如，博客帖子可能有無限數量的評論。與所有其他關系一樣，定義了一對多關系`$hasMany`，在模型的屬性中添加了一個條目： ~~~ class Post extends Model { public $hasMany = [ 'comments' => 'Acme\Blog\Models\Comment' ]; } ~~~ 請記住，模型將自動確定模型上正確的外鍵列`Comment`。按照慣例，它將采用擁有模型的“ snake case”名稱，并在其后綴`_id`。因此，對于此示例，我們可以假定`Comment`模型上的外鍵為`post_id`。定義關系后，我們可以通過訪問`comments`屬性來訪問評論集合。請記住，由于模型提供了“動態屬性”，因此我們可以像在模型上將它們定義為屬性一樣訪問關系： ~~~ $comments = Post::find(1)->comments; foreach ($comments as $comment) { // } ~~~ 當然，由于所有關系也都可以用作查詢生成器，因此可以通過調用`comments`方法并繼續將條件鏈接到查詢上來為注釋添加更多約束： ~~~ $comments = Post::find(1)->comments()->where('title', 'foo')->first(); ~~~ 像該`hasOne`關系一樣，您還可以通過分別在定義上傳遞`key`和`otherKey`參數來覆蓋外鍵和本地鍵： ~~~ public $hasMany = [ 'comments' => ['Acme\Blog\Models\Comment', 'key' => 'my_post_id', 'otherKey' => 'my_id'] ]; ~~~ #### 定義關系的逆關系現在我們可以訪問帖子的所有評論，讓我們定義一個關系以允許評論訪問其父帖子。要定義`hasMany`關系的逆關系，請`$belongsTo`在子模型上定義屬性： ~~~ class Comment extends Model { public $belongsTo = [ 'post' => 'Acme\Blog\Models\Post' ]; } ~~~ 一旦定義了關系，我們可以通過訪問“動態屬性”來檢索`Post`模型：`Comment``post` ~~~ $comment = Comment::find(1); echo $comment->post->title; ~~~ 在上面的例子中，模型將嘗試匹配的`post_id`從`Comment`模型到一個`id`上`Post`的模型。它通過檢查關系的名稱并為它加后綴來確定默認的外鍵名稱`_id`。但是，如果`Comment`模型上的外鍵不是`post_id`，則可以使用以下`key`參數傳遞自定義鍵名稱： ~~~ public $belongsTo = [ 'post' => ['Acme\Blog\Models\Post', 'key' => 'my_post_id'] ]; ~~~ 如果您的父模型不用`id`作其主鍵，或者您希望將子模型連接到其他列，則可以將`otherKey`參數傳遞給指定父表的自定義鍵的定義： ~~~ public $belongsTo = [ 'post' => ['Acme\Blog\Models\Post', 'key' => 'my_post_id', 'otherKey' => 'my_id'] ]; ~~~ ### [](https://octobercms.com/docs/database/relations#many-to-many)多對多多對多關系比`hasOne`和`hasMany`關系稍微復雜。這種關系的一個示例是具有多個角色的用戶，其中這些角色也由其他用戶共享。例如，許多用戶可能具有“管理員”角色。要定義這種關系，需要三個數據庫表：`users`，`roles`，和`role_user`。該`role_user`表是從相關模型名稱的字母順序得出的，并且包含`user_id`和`role_id`列。下面的示例顯示了用于創建聯接表的[數據庫表結構](https://octobercms.com/docs/plugin/updates#migration-files)。 ~~~ Schema::create('role_user', function($table) { $table->integer('user_id')->unsigned(); $table->integer('role_id')->unsigned(); $table->primary(['user_id', 'role_id']); }); ~~~ 定義了多對多關系`$belongsToMany`，在模型類的屬性上添加了一個條目。例如，讓`roles`我們在`User`模型上定義方法： ~~~ class User extends Model { public $belongsToMany = [ 'roles' => 'Acme\Blog\Models\Role' ]; } ~~~ 定義關系后，您可以使用`roles`dynamic屬性訪問用戶的角色： ~~~ $user = User::find(1); foreach ($user->roles as $role) { // } ~~~ 當然，像所有其他關系類型一樣，您可以調用該`roles`方法以繼續將查詢約束鏈接到該關系上： ~~~ $roles = User::find(1)->roles()->orderBy('name')->get(); ~~~ 如前所述，為了確定關系的聯接表的表名，模型將按字母順序聯接兩個相關的模型名。但是，您可以隨意重寫此約定。您可以通過將`table`參數傳遞給`belongsToMany`定義來實現： ~~~ public $belongsToMany = [ 'roles' => ['Acme\Blog\Models\Role', 'table' => 'acme_blog_role_user'] ]; ~~~ 除了自定義聯接表的名稱之外，還可以通過將其他參數傳遞給`belongsToMany`定義來自定義表上鍵的列名。該`key`參數是要為其定義關系模型的外鍵名稱，而`otherKey`參數是要加入到模型的外鍵名： ~~~ public $belongsToMany = [ 'roles' => [ 'Acme\Blog\Models\Role', 'table' => 'acme_blog_role_user', 'key' => 'my_user_id', 'otherKey' => 'my_role_id' ] ]; ~~~ #### 定義關系的逆關系要定義多對多關系的逆關系，只需`$belongsToMany`在相關模型上放置另一個屬性即可。繼續我們的用戶角色示例，讓我們`users`在`Role`模型上定義關系： ~~~ class Role extends Model { public $belongsToMany = [ 'users' => 'Acme\Blog\Models\User' ]; } ~~~ 如您所見，該關系的定義與其`User`對應關系完全相同，只是簡單地引用了`Acme\Blog\Models\User`模型。由于我們正在重用該`$belongsToMany`屬性，因此在定義多對多關系的逆關系時，所有常用的表和鍵自定義選項均可用。 #### 檢索中間表列如您所知，使用多對多關系需要一個中間聯接表。模型提供了一些與該表進行交互的非常有用的方法。例如，假設我們的`User`對象有許多`Role`與之相關的對象。訪問此關系后，我們可以使用`pivot`模型上的屬性訪問中間表： ~~~ $user = User::find(1); foreach ($user->roles as $role) { echo $role->pivot->created_at; } ~~~ 請注意，`Role`我們檢索的每個模型都會自動分配一個`pivot`屬性。此屬性包含表示中間表的模型，并且可以像其他任何模型一樣使用。默認情況下，只有模型關鍵點會出現在`pivot`對象上。如果數據透視表包含額外的屬性，則在定義關系時必須指定它們： ~~~ public $belongsToMany = [ 'roles' => [ 'Acme\Blog\Models\Role', 'pivot' => ['column1', 'column2'] ] ]; ~~~ 如果希望您的數據透視表具有自動維護`created_at`和`updated_at`時間戳記，請使用`timestamps`關系定義上的參數： ~~~ public $belongsToMany = [ 'roles' => ['Acme\Blog\Models\Role', 'timestamps' => true] ]; ~~~ 這些是`belongsToMany`關系支持的參數： | 論據 | 描述 | | --- | --- | | **table** | 聯接表的名稱。 | | **key** | 定義模型的關鍵列名稱（在數據透視表內部）。默認值由型號名稱和`_id`后綴組合而成，即`user_id` | | **parentKey** | 定義模型的鍵列名稱（在定義模型表內部）。默認值：id | | **otherKey** | 相關模型的關鍵列名稱（在數據透視表內部）。默認值由型號名稱和`_id`后綴組合而成，即`role_id` | | **relatedKey** | 相關模型的關鍵列名稱（在相關模型表內部）。默認值：id | | **pivot** | 在聯接表中找到的一組樞軸列，可通過訪問屬性`$model->pivot`。 | | **pivotModel** | 指定訪問樞紐關系時要返回的自定義模型類。默認為`October\Rain\Database\Pivot`。 | | **timestamps** | 如果為true，則聯接表應包含`created_at`和`updated_at`列。默認值：false | ### [](https://octobercms.com/docs/database/relations#has-many-through)有很多通過擁有多次關系為通過中間關系訪問遠處的關系提供了方便的捷徑。例如，一個`Country`模型可能`Post`通過中間`User`模型具有許多模型。在此示例中，您可以輕松地收集給定國家/地區的所有博客文章。讓我們看一下定義此關系所需的表： ~~~ countries id - integer name - string users id - integer country_id - integer name - string posts id - integer user_id - integer title - string ~~~ 盡管`posts`不包含`country_id`列，但該`hasManyThrough`關系可通過訪問該國家/地區的帖子`$country->posts`。要執行此查詢，模型將檢查`country_id`中間`users`表上的。找到匹配的用戶標識后，將使用它們來查詢`posts`表。現在我們已經檢查了關系的表結構，讓我們在`Country`模型上定義它： ~~~ class Country extends Model { public $hasManyThrough = [ 'posts' => [ 'Acme\Blog\Models\Post', 'through' => 'Acme\Blog\Models\User' ], ]; } ~~~ 傳遞給該`$hasManyThrough`關系的第一個參數是我們希望訪問的最終模型的名稱，而`through`參數是中間模型的名稱。執行關系查詢時，將使用典型的外鍵約定。如果您想自定義關系的鑰匙，你可以通過他們的`key`，`otherKey`和`throughKey`參數的`$hasManyThrough`定義。該`key`參數是在中間模型外鍵的名稱，`throughKey`參數是最終的模型外鍵的名稱，而`otherKey`為本地密鑰。 ~~~ public $hasManyThrough = [ 'posts' => [ 'Acme\Blog\Models\Post', 'key' => 'my_country_id', 'through' => 'Acme\Blog\Models\User', 'throughKey' => 'my_user_id', 'otherKey' => 'my_id' ], ]; ~~~ ### [](https://octobercms.com/docs/database/relations#has-one-through)一通一對一關系通過單個中間關系鏈接模型。例如，如果每個供應商有一個用戶，并且每個用戶與一個用戶歷史記錄相關聯，則供應商模型可以通過用戶訪問用戶的歷史。讓我們看一下定義此關系所需的數據庫表： ~~~ users id - integer supplier_id - integer suppliers id - integer history id - integer user_id - integer ~~~ 盡管該`history`表不包含`supplier_id`列，但是該`hasOneThrough`關系可以提供對供應商模型的用戶歷史記錄的訪問。現在我們已經檢查了關系的表結構，讓我們在`Supplier`模型上定義它： ~~~ class Supplier extends Model { public $hasOneThrough = [ 'userHistory' => [ 'Acme\Supplies\Model\History', 'through' => 'Acme\Supplies\Model\User' ], ]; } ~~~ 傳遞給該`$hasOneThrough`屬性的第一個數組參數是我們希望訪問的最終模型的名稱，而`through`鍵是中間模型的名稱。執行關系查詢時，將使用典型的外鍵約定。如果您想自定義關系的鑰匙，你可以通過他們的`key`，`otherKey`和`throughKey`參數的`$hasManyThrough`定義。該`key`參數是在中間模型外鍵的名稱，`throughKey`參數是最終的模型外鍵的名稱，而`otherKey`為本地密鑰。 ~~~ public $hasOneThrough = [ 'userHistory' => [ 'Acme\Supplies\Model\History', 'key' => 'supplier_id', 'through' => 'Acme\Supplies\Model\User' 'throughKey' => 'user_id', 'otherKey' => 'id' ], ]; ~~~