Many-to-many (belongsToMany) in Laravel - Mini Project: Build & Apply

Many-to-many Relationship with belongsToMany in Laravel

📖 Scenario: You are building a simple blog system where posts can have many tags, and tags can belong to many posts. This is a common real-world case where many items relate to many others.

🎯 Goal: Create a many-to-many relationship between Post and Tag models using Laravel's belongsToMany method. You will set up the data structure, configure the pivot table, define the relationship methods, and finally retrieve tags for a post.

📋 What You'll Learn

Create a pivot table migration named post_tag with post_id and tag_id columns

Define a tags method in the Post model using belongsToMany

Define a posts method in the Tag model using belongsToMany

Retrieve all tags for a given post using the tags relationship

💡 Why This Matters

🌍 Real World

Many web applications need to relate items in a many-to-many way, such as posts and tags, users and roles, or products and categories.

💼 Career

Understanding Laravel's many-to-many relationships is essential for backend developers working with databases and Eloquent ORM.

1

Create the pivot table migration

Create a migration file for the pivot table named post_tag with two unsigned big integer columns: post_id and tag_id. Use the Laravel schema builder to define these columns and set them as foreign keys referencing id on posts and tags tables respectively.

Laravel

// Your code here to create the post_tag pivot table migration
Schema::create('post_tag', function (Blueprint $table) {
    // Your code here
});

Hint

Use Schema::create with a closure that receives $table. Add unsignedBigInteger columns for post_id and tag_id. Then add foreign key constraints referencing posts and tags tables.

2

Define the belongsToMany relationship in Post model

In the Post model, add a public method named tags that returns the result of calling belongsToMany(Tag::class). This sets up the many-to-many relationship from posts to tags.

Laravel

Schema::create('post_tag', function (Blueprint $table) {
    $table->unsignedBigInteger('post_id');
    $table->unsignedBigInteger('tag_id');
    $table->foreign('post_id')->references('id')->on('posts')->onDelete('cascade');
    $table->foreign('tag_id')->references('id')->on('tags')->onDelete('cascade');
    $table->primary(['post_id', 'tag_id']);
});

// Add the tags() method inside the Post model
// Your code here

Hint

Inside the Post model class, define a public method tags that returns $this->belongsToMany(Tag::class).

3

Define the belongsToMany relationship in Tag model

In the Tag model, add a public method named posts that returns the result of calling belongsToMany(Post::class). This sets up the many-to-many relationship from tags to posts.

Laravel

Schema::create('post_tag', function (Blueprint $table) {
    $table->unsignedBigInteger('post_id');
    $table->unsignedBigInteger('tag_id');
    $table->foreign('post_id')->references('id')->on('posts')->onDelete('cascade');
    $table->foreign('tag_id')->references('id')->on('tags')->onDelete('cascade');
    $table->primary(['post_id', 'tag_id']);
});

class Post extends Model
{
    public function tags()
    {
        return $this->belongsToMany(Tag::class);
    }
}

// Add the posts() method inside the Tag model
// Your code here

Hint

Inside the Tag model class, define a public method posts that returns $this->belongsToMany(Post::class).

4

Retrieve tags for a post

Write code to retrieve all tags for a Post instance stored in a variable named $post. Use the tags relationship method to get the collection of tags and assign it to a variable named $tags.

Laravel

Schema::create('post_tag', function (Blueprint $table) {
    $table->unsignedBigInteger('post_id');
    $table->unsignedBigInteger('tag_id');
    $table->foreign('post_id')->references('id')->on('posts')->onDelete('cascade');
    $table->foreign('tag_id')->references('id')->on('tags')->onDelete('cascade');
    $table->primary(['post_id', 'tag_id']);
});

class Post extends Model
{
    public function tags()
    {
        return $this->belongsToMany(Tag::class);
    }
}

class Tag extends Model
{
    public function posts()
    {
        return $this->belongsToMany(Post::class);
    }
}

// Assume $post is an instance of Post
$tags = null; // Your code here to get tags

Hint

Use the tags property or method on the $post object to get all related tags and assign it to $tags.

Practice

1. What does the belongsToMany() method define in a Laravel model?

easy

A. A polymorphic relationship between models

B. A one-to-one relationship between two models

C. A one-to-many relationship from one model to another

D. A many-to-many relationship between two models

Solution

1. Step 1: Understand relationship types in Laravel

   Laravel provides different methods to define relationships: one-to-one, one-to-many, many-to-many, and polymorphic.

2. Step 2: Identify the purpose of belongsToMany()

   The belongsToMany() method specifically defines a many-to-many relationship where both models can have multiple related models.

3. Final Answer:

   A many-to-many relationship between two models -> Option D

4. Quick Check:

   belongsToMany() = many-to-many [OK]

Hint: belongsToMany means many-to-many link between models [OK]

Common Mistakes:

• Confusing belongsToMany with hasOne or hasMany
• Thinking it defines one-to-one relationships
• Assuming it creates a polymorphic relation

2. Which of the following is the correct syntax to define a many-to-many relationship in a Laravel model named Post related to Tag?

easy

A. public function tags() { return $this->belongsToMany(Tag::class); }

B. public function tags() { return $this->hasMany(Tag::class); }

C. public function tags() { return $this->hasOne(Tag::class); }

D. public function tags() { return $this->morphToMany(Tag::class); }

Solution

1. Step 1: Recall the method for many-to-many relationships

   In Laravel, many-to-many relationships use the belongsToMany() method inside the model.

2. Step 2: Match the syntax to the correct method

   The correct syntax is public function tags() { return $this->belongsToMany(Tag::class); } to link Post and Tag models.

3. Final Answer:

   public function tags() { return $this->belongsToMany(Tag::class); } -> Option A

4. Quick Check:

   belongsToMany() syntax = public function tags() { return $this->belongsToMany(Tag::class); } [OK]

Hint: Use belongsToMany() for many-to-many syntax [OK]

Common Mistakes:

• Using hasMany instead of belongsToMany
• Using hasOne which is one-to-one
• Confusing morphToMany with belongsToMany

3. Given the following code in a Laravel model User:

public function roles() {
    return $this->belongsToMany(Role::class);
}

$user = User::find(1);
$roles = $user->roles()->pluck('name');
echo $roles->toJson();

What will be the output if user 1 has roles named "admin" and "editor"?

medium

A. Syntax error

B. ["1","2"]

C. ["admin","editor"]

D. null

Solution

1. Step 1: Understand the belongsToMany relationship usage

   The roles() method returns all roles related to the user via the pivot table.

2. Step 2: Analyze the pluck and toJson methods

   The pluck('name') extracts the 'name' field from each related role, returning a collection of role names. toJson() converts this collection to a JSON string.

3. Final Answer:

   ["admin","editor"] -> Option C

4. Quick Check:

   pluck('name') + toJson() = role names JSON [OK]

Hint: pluck('name') gets names; toJson outputs JSON array [OK]

Common Mistakes:

• Expecting IDs instead of names
• Thinking roles() returns null if no roles
• Confusing pluck with get

4. What is wrong with this Laravel many-to-many relationship definition in the Product model?

public function categories() {
    return $this->hasMany(Category::class);
}

medium

A. The method name should be singular, like category()

B. It should use belongsToMany() instead of hasMany()

C. The related model class name is incorrect

D. No return statement is needed

Solution

1. Step 1: Identify the relationship type

   Products and categories usually have a many-to-many relationship, so belongsToMany() is the correct method.

2. Step 2: Check the method used

   The code uses hasMany(), which defines a one-to-many relationship, not many-to-many.

3. Final Answer:

   It should use belongsToMany() instead of hasMany() -> Option B

4. Quick Check:

   Many-to-many needs belongsToMany(), not hasMany() [OK]

Hint: Many-to-many always uses belongsToMany() [OK]

Common Mistakes:

• Using hasMany for many-to-many
• Naming method singular for plural relation
• Omitting return statement

5. You have two models, Student and Course, linked by a many-to-many relationship using a pivot table course_student. You want to attach a course with ID 5 to a student with ID 3 and also store the enrollment date in the pivot. Which code snippet correctly does this?

hard

A. $student = Student::find(3);
$student->courses()->attach(5, ['enrolled_at' => now()]);

B. $student = Student::find(3);
$student->courses()->save(5, ['enrolled_at' => now()]);

C. $student = Student::find(3);
$student->courses()->sync(5, ['enrolled_at' => now()]);

D. $student = Student::find(3);
$student->courses()->attach([5]);

Solution

1. Step 1: Understand attaching in many-to-many with pivot data

   The attach() method adds a record to the pivot table and accepts the related model ID plus an array of extra pivot data.

2. Step 2: Analyze each option

   $student = Student::find(3); $student->courses()->attach(5, ['enrolled_at' => now()]); correctly uses attach(5, ['enrolled_at' => now()]). $student = Student::find(3); $student->courses()->save(5, ['enrolled_at' => now()]); uses save() which expects a model instance, not an ID. $student = Student::find(3); $student->courses()->sync(5, ['enrolled_at' => now()]); uses sync() incorrectly with extra data. $student = Student::find(3); $student->courses()->attach([5]); attaches without pivot data.

3. Final Answer:

   $student = Student::find(3); $student->courses()->attach(5, ['enrolled_at' => now()]); -> Option A

4. Quick Check:

   attach(id, pivotData) = $student = Student::find(3); $student->courses()->attach(5, ['enrolled_at' => now()]); [OK]

Hint: Use attach(id, pivotData) to add with extra pivot info [OK]

Common Mistakes:

• Using save() with ID instead of model instance
• Using sync() incorrectly with pivot data
• Forgetting to pass pivot data array