Resource collections in Laravel - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to return a resource collection in Laravel.

Laravel

return [1]::collection($users);

Drag options to blanks, or click blank then click option'

AUserModel

BUserCollection

CUserResource

DUserController

Attempts:

3 left

💡 Hint

Common Mistakes

Using the model class instead of the resource class.

Using a collection class that does not exist.

Calling collection on the controller.

In Laravel, to return a resource collection, you use the resource class with the collection method. Here, UserResource is the correct resource class.

2fill in blank

medium

Complete the code to create a resource collection class using Artisan.

Laravel

php artisan make:resource [1] --collection

Drag options to blanks, or click blank then click option'

AUserResource

BUserController

CUserModel

DUserCollection

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'UserResource' (single resource) instead of 'UserCollection'.

Omitting the --collection flag.

Using model or controller names.

The make:resource command with the --collection flag creates a resource collection class. The conventional name is UserCollection.

3fill in blank

hard

Fix the error in the resource collection response code.

Laravel

return new [1]($users);

Drag options to blanks, or click blank then click option'

AUserModel

BUserCollection

CUserResource

DUserController

Attempts:

3 left

💡 Hint

Common Mistakes

Using the single resource class for multiple items.

Using the model or controller class.

Not wrapping the data in a resource or collection.

When returning a resource collection as a new instance, you should use the collection class, like UserCollection, not the single resource class.

4fill in blank

hard

Fill both blanks to define a resource collection class extending the correct base class.

Laravel

class UserCollection extends [1]
{
    public function toArray($request)
    {
        return [2]::collection($this->collection);
    }
}

Drag options to blanks, or click blank then click option'

AIlluminate\Http\Resources\Json\ResourceCollection

BUserResource

CUserModel

DController

Attempts:

3 left

💡 Hint

Common Mistakes

Extending the model or controller instead of ResourceCollection.

Returning the collection directly without wrapping.

Using the wrong resource class inside toArray.

A resource collection class extends ResourceCollection from Laravel. Inside toArray, it returns a collection of the single resource class, here UserResource.

5fill in blank

hard

Fill all three blanks to customize the resource collection's additional data.

Laravel

public function with($request)
{
    return [
        '[1]' => [2],
        '[3]' => 'Success'
    ];
}

Drag options to blanks, or click blank then click option'

Ameta

B['version' => '1.0']

Cstatus

Dtrue

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect keys like 'data' or 'info' instead of 'meta'.

Setting 'meta' value as a string instead of an array.

Omitting the 'status' key or using wrong values.

The with method adds extra data to the resource response. The key meta is used for metadata, and status can indicate success. The value for meta is an array with version info.

Practice

1. What is the primary purpose of using ::collection() in Laravel resource classes?

easy

A. To delete multiple records from the database

B. To create a single model instance

C. To format multiple model instances consistently in API responses

D. To validate incoming request data

Solution

1. Step 1: Understand the role of resource collections

   Resource collections are used to format many items in the same way for API responses.

2. Step 2: Identify what ::collection() does

   The ::collection() method wraps multiple model instances to apply the resource formatting to each item.

3. Final Answer:

   To format multiple model instances consistently in API responses -> Option C

4. Quick Check:

   Resource collections format many items = A [OK]

Hint: Remember: ::collection() wraps many models for consistent output [OK]

Common Mistakes:

• Confusing ::collection() with single model resource
• Thinking it deletes or modifies database records
• Mixing it up with validation methods

2. Which of the following is the correct syntax to return a resource collection for a list of users stored in $users using a resource class UserResource?

easy

A. return UserResource::collection($users);

B. return new UserResource($users);

C. return UserResource::make($users);

D. return UserResource::all($users);

Solution

1. Step 1: Recall the syntax for resource collections

   To format multiple models, use ::collection() on the resource class with the collection as argument.

2. Step 2: Match the syntax with options

   return UserResource::collection($users); uses UserResource::collection($users); which is correct. Other options either create a single resource or use invalid methods.

3. Final Answer:

   return UserResource::collection($users); -> Option A

4. Quick Check:

   Correct syntax for collections = D [OK]

Hint: Use ::collection() for multiple items, not new [OK]

Common Mistakes:

• Using new UserResource($users) for collections
• Using non-existent methods like all() or make()
• Confusing single resource and collection syntax

3. Given the following code, what will be the output structure of the API response?

return UserResource::collection($users)->additional(['meta' => ['total' => $users->count()]]);

medium

A. A plain array of user models without formatting

B. A JSON with only a 'meta' object and no user data

C. A JSON with a 'data' array but no meta information

D. A JSON with a 'data' array of users and a 'meta' object containing total count

Solution

1. Step 1: Understand additional() method usage

   The additional() method adds extra data (like meta info) to the resource collection response.

2. Step 2: Analyze the returned structure

   The response will have a data key with formatted users and a meta key with the total count from additional().

3. Final Answer:

   A JSON with a 'data' array of users and a 'meta' object containing total count -> Option D

4. Quick Check:

   Collection + additional meta = data + meta JSON [OK]

Hint: Remember additional() adds extra keys outside 'data' [OK]

Common Mistakes:

• Expecting meta inside each user item instead of outside
• Thinking additional() replaces data instead of adding
• Confusing plain arrays with resource formatted output

4. Identify the error in the following code snippet that tries to return a resource collection:

return UserResource::collection()->additional(['status' => 'success']);

medium

A. Missing the collection argument inside collection()

B. Using additional() is not allowed on collections

C. Should use new UserResource() instead of collection()

D. The additional() method requires a string, not an array

Solution

1. Step 1: Check the usage of collection()

   The collection() method requires a collection or array argument to wrap. Here it is called without any argument.

2. Step 2: Validate other method usages

   additional() can be used on collections and accepts an array. Using new UserResource() is for single models, not collections.

3. Final Answer:

   Missing the collection argument inside collection() -> Option A

4. Quick Check:

   collection() needs argument [OK]

Hint: Always pass your data to collection() [OK]

Common Mistakes:

• Calling collection() without data
• Thinking additional() is invalid on collections
• Confusing single resource and collection usage

5. You want to return a paginated list of posts with a resource collection and include extra pagination info under a meta key. Which code snippet correctly achieves this?

hard

A. return PostResource::collection($posts->paginate(10))->additional(['meta' => ['current_page' => $posts->currentPage()]]);

B. return PostResource::collection($posts->paginate(10))->additional(['meta' => ['current_page' => $posts->paginate(10)->currentPage()]]);

C. return PostResource::collection($posts)->additional(['meta' => ['current_page' => $posts->currentPage()]]);

D. return new PostResource($posts->paginate(10))->additional(['meta' => ['current_page' => $posts->paginate(10)->currentPage()]]);

Solution

1. Step 1: Understand pagination and resource collections

   When paginating, call paginate(10) on the query to get a paginator instance. Pass this to collection().

2. Step 2: Access pagination info correctly

   To access currentPage(), it must be called on the paginator returned by paginate(), not on the original query builder $posts.

3. Step 3: Identify correct option

   The snippet that calls $posts->paginate(10)->currentPage() within additional() correctly retrieves the current page from a paginator instance, ensuring the paginated data and meta align.

4. Final Answer:

   return PostResource::collection($posts->paginate(10))->additional(['meta' => ['current_page' => $posts->paginate(10)->currentPage()]]); -> Option B

5. Quick Check:

   paginate() result for both collection and currentPage() [OK]

Hint: Access pagination methods on paginate() result, not query builder [OK]

Common Mistakes:

• Calling currentPage() on query builder $posts
• Passing unpaginated $posts to collection()
• Using new Resource() for paginated collections