Single action controllers in Laravel

Introduction

Single action controllers help keep your code simple by focusing on one job per controller. This makes your app easier to understand and maintain.

When you have a controller that only needs to handle one route or action.

When you want to keep your code clean and organized by separating different tasks.

When building small features that don't require multiple methods.

When you want to quickly create a controller for a single purpose like showing a page or processing a form.

Syntax

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ExampleController
{
    public function __invoke(Request $request)
    {
        // Your code here
    }
}

The __invoke method is special in PHP and lets the controller be called like a function.

You don't need to define multiple methods; just one __invoke handles the action.

Examples

This controller shows a profile page when called.

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ShowProfileController
{
    public function __invoke(Request $request)
    {
        return view('profile.show');
    }
}

This controller processes a form submission and redirects the user.

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class SubmitFormController
{
    public function __invoke(Request $request)
    {
        // Process form data
        return redirect('/thank-you');
    }
}

Sample Program

This single action controller returns a simple welcome message when its route is accessed.

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class WelcomeController
{
    public function __invoke(Request $request)
    {
        return response('Welcome to our site!');
    }
}

Important Notes

Register single action controllers in routes using the controller class name without specifying a method.

Example route: Route::get('/welcome', WelcomeController::class);

Single action controllers improve readability and reduce boilerplate code.

Summary

Single action controllers use the __invoke method to handle one action.

They keep your code focused and easier to maintain.

Use them when your controller only needs to do one thing.

Practice

1. What is the main purpose of a single action controller in Laravel?

easy

A. To replace middleware functionality

B. To manage multiple actions in one controller

C. To handle exactly one action using the __invoke method

D. To handle database migrations

Solution

1. Step 1: Understand the role of single action controllers

   Single action controllers are designed to handle only one action, making code simpler and focused.

2. Step 2: Identify the method used

   They use the special __invoke method to handle that single action.

3. Final Answer:

   To handle exactly one action using the __invoke method -> Option C

4. Quick Check:

   Single action controller = __invoke method [OK]

Hint: Single action controllers always use __invoke method [OK]

Common Mistakes:

• Thinking they handle multiple actions
• Confusing with middleware or migrations
• Assuming they require multiple methods

2. Which of the following is the correct syntax to define a single action controller in Laravel?

easy

A. class MyController { public function __invoke() {} }

B. class MyController { public function handle() {} }

C. class MyController { public function index() {} }

D. class MyController { public function action() {} }

Solution

1. Step 1: Recall the special method for single action controllers

   Single action controllers use the __invoke() method to handle the action.

2. Step 2: Match the syntax

   The correct syntax defines a class with a public function __invoke() method.

3. Final Answer:

   class MyController { public function __invoke() {} } -> Option A

4. Quick Check:

   __invoke method syntax = class MyController { public function __invoke() {} } [OK]

Hint: Look for __invoke method in the class [OK]

Common Mistakes:

• Using index() or handle() instead of __invoke()
• Forgetting the public visibility
• Confusing method names with other controller types

3. Given this single action controller code, what will be the output when accessed?

class WelcomeController {
    public function __invoke() {
        return 'Hello, Laravel!';
    }
}

medium

A. Hello, Laravel!

B. Error: Method not found

C. Empty response

D. 404 Not Found

Solution

1. Step 1: Understand __invoke method behavior

   The __invoke method runs when the controller is called as a single action, returning the string 'Hello, Laravel!'.

2. Step 2: Predict the output

   Since the method returns a string, the response will be that string displayed.

3. Final Answer:

   Hello, Laravel! -> Option A

4. Quick Check:

   __invoke returns string = 'Hello, Laravel!' [OK]

Hint: __invoke returns output directly as response [OK]

Common Mistakes:

• Expecting an error due to missing method name
• Thinking it returns empty or 404
• Confusing with multi-method controllers

4. Identify the error in this single action controller code:

class TestController {
    public function invoke() {
        return 'Test';
    }
}

medium

A. Return statement is invalid

B. Method should be private, not public

C. Class name must be TestActionController

D. Missing __invoke method name with double underscores

Solution

1. Step 1: Check method name for single action controller

   The method must be named __invoke with two underscores, not invoke.

2. Step 2: Verify method visibility and return

   Method should be public and return a value, which is correct here.

3. Final Answer:

   Missing __invoke method name with double underscores -> Option D

4. Quick Check:

   Method name must be __invoke [OK]

Hint: Method must be named __invoke with double underscores [OK]

Common Mistakes:

• Using invoke instead of __invoke
• Changing method visibility incorrectly
• Assuming class name affects single action controller

5. You want to create a single action controller that returns a JSON response with a message 'Success'. Which code snippet correctly implements this?

hard

A. class JsonResponseController {
public function __invoke() {
return json_encode(['message' => 'Success']);
}
}

B. class JsonResponseController {
public function __invoke() {
return response()->json(['message' => 'Success']);
}
}

C. class JsonResponseController {
private function __invoke() {
return ['message' => 'Success'];
}
}

D. class JsonResponseController {
public function handle() {
return json(['message' => 'Success']);
}
}

Solution

1. Step 1: Use __invoke method for single action controller

   The controller must have a public __invoke() method to be a single action controller.

2. Step 2: Return a proper JSON response in Laravel

   Use Laravel's response()->json() helper to return a JSON response correctly.

3. Final Answer:

   class JsonResponseController { public function __invoke() { return response()->json(['message' => 'Success']); } } -> Option B

4. Quick Check:

   __invoke + response()->json() = class JsonResponseController { public function __invoke() { return response()->json(['message' => 'Success']); } } [OK]

Hint: Use response()->json() inside __invoke method [OK]

Common Mistakes:

• Using handle() instead of __invoke()
• Returning raw arrays without response helper
• Using json() function which doesn't exist in Laravel