sync()

シンク（リレーション）

意味多対多関係の同期

sync()とは？

sync()メソッドは、Laravelで多対多リレーションにおいて、関連付けられたモデル間の関係を同期するために使用されます。このメソッドは、指定された IDのみが中間テーブルに存在するようにし、他の関連付けは削除します。

sync()の具体的な使い方

ユーザーのロールを同期する例

// ユーザーモデルが与えられているとします
$user = User::find(1);

// 同期したいロールIDの配列
$rolesToSync = [1, 3, 5];

// ロールを同期
$result = $user->roles()->sync($rolesToSync);

echo "ロールが同期されました。";
echo "追加されたロール: " . implode(', ', $result['attached']);
echo "削除されたロール: " . implode(', ', $result['detached']);

// 現在のロールを確認
$currentRoles = $user->roles()->pluck('id')->toArray();
echo "現在のロール: " . implode(', ', $currentRoles);

👇出力結果

ロールが同期されました。
追加されたロール: 3, 5
削除されたロール: 2, 4
現在のロール: 1, 3, 5

この例では、ユーザーのロールを指定された一連のIDと同期しています。sync()メソッドは、指定されたIDのみがユーザーに関連付けられるようにします。既存の関連付けで指定されていないものは削除され、新しい関連付けが追加されます。メソッドの戻り値から、どのロールが追加され、どのロールが削除されたかを確認できます。

追加データを含むロール同期の例

// ユーザーモデルが与えられているとします
$user = User::find(1);

// 同期したいロールIDと追加データの配列
$rolesToSync = [
    1 => ['expires_at' => '2023-12-31'],
    3 => ['expires_at' => '2024-06-30'],
    5 => ['expires_at' => '2023-09-30']
];

// ロールを同期（追加データ付き）
$user->roles()->sync($rolesToSync);

echo "ロールが追加データと共に同期されました。";

// 現在のロールと追加データを確認
$currentRoles = $user->roles()->with('pivot')->get();
foreach ($currentRoles as $role) {
    echo "ロールID: {$role->id}, 有効期限: {$role->pivot->expires_at}";
}

👇出力結果

ロールが追加データと共に同期されました。
ロールID: 1, 有効期限: 2023-12-31
ロールID: 3, 有効期限: 2024-06-30
ロールID: 5, 有効期限: 2023-09-30

この例では、ロールを同期する際に追加のデータ（この場合は有効期限）も含めています。sync()メソッドに渡す配列のキーとしてロールIDを使用し、値として追加データの配列を指定します。このようにすることで、中間テーブルに追加のカラムを含めることができます。

sync()に関するよくある質問

Q. sync()と attach()の違いは？

A. sync()は指定されたIDのみが関連付けられるように同期しますが、attach()は既存の関連付けを維持したまま新しい関連付けを追加します。sync()は既存の関連付けを上書きする一方で、attach()は追加のみを行います。

Q. sync()で追加のデータを含められる？

A. はい、sync()メソッドでは、中間テーブルに追加のデータを含めることができます。例えば、$user->roles()->sync([1 => ['expires' => '2023-12-31'], 2, 3]); のように、ID 1のロールに有効期限を設定できます。

Q. sync()の戻り値は何？

A. sync()メソッドは、変更の詳細を含む配列を返します。この配列には 'attached'（新しく追加されたID）、'detached'（削除されたID）、'updated'（更新されたID）のキーが含まれます。

sync()が学べる書籍の紹介

「プログラミング単語帳」を使って、プログラミングの単語を英単語のように学習してみませんか？
プログラミング単語帳には、Laravelのsync()やmorphOne()、hasOne()、hasMany()、などのような実務でよく使われる単語が数百以上収録されています。
この書籍には、プログラミングの単語の意味や読み方、単語の使い方がわかる例文などが掲載されており、いつでもどこでもプログラミングの学習ができます。

よく使われる単語にだけ絞って学習することができるので、効率的にプログラミングが学習できます。