Laravel 5.5 Responsable Interface for Responses

Published on by

Laravel 5.5 Responsable Interface for Responses image

A new return type will be supported in Laravel 5.5 routes: the Responsable interface. This contract allows objects to be converted to an HTTP response instance when returned from a controller or route closure. A Responsable object needs to implement a toResponse() method which represents the object as an HTTP response.

<?php
 
use Illuminate\Contracts\Support\Responsable;
 
class ExampleObject implements Responsable
{
public function __construct($name = null)
{
$this->name = $name ?? 'Teapot';
}
 
public function status()
{
switch(strtolower($this->name)) {
case 'teapot':
return 418;
default:
return 200;
}
}
 
public function toResponse()
{
return response(
"Hello {$this->name}",
$this->status(),
['X-Person' => $this->name]
);
}
}

Using the ExampleObject in a route, you can now do something like this:

Route::get('/hello', function () {
return new ExampleObject(request('name'));
});

In the framework, the Router class now checks for this type when preparing the response:

if ($response instanceof Responsable) {
$response = $response->toResponse();
}

Let’s say you have various response types in the App\Http\Responses namespace to organize your responses. One example might look like this to support a Posts model:

<?php
 
namespace App\Http\Responses;
 
class PostIndexResponse extends Response
{
public function __construct($posts)
{
$this->posts = $posts;
}
 
public function toResponse()
{
return response()->json($this->transformPosts());
}
 
protected function transformPosts()
{
return $this->posts->map(function ($post) {
return [
'title' => $post->title,
'description' => $post->description,
'body' => $post->body,
'published_date' => $post->published_at->toIso8601String(),
'created' => $post->created_at->toIso8601String(),
];
});
}
}

This is a basic example that illustrates a simple use-case. It returns a JSON response, but you might want the response layer include additional functionality like content negotiation. The example above also assumes an App\Http\Responses\Response class that could provide some base functionality. The response layer could also contain transformation code like Fractal instead of using it directly in the controller.

A controller that works with the PostsIndexResponse might look like the following:

<?php
 
namespace App\Http\Controllers;
 
use App\Http\Responses;
 
class PostsController extends Controller
{
public function index()
{
$posts = \App\Post::all();
 
return new Responses\PostIndexResponse($posts);
}
}

Check out the commit implementing this contract. While simple, I think it will be interesting to see how people will use Responsable in Laravel 5.5.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

Visit DocuWriter.ai
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
Bacancy - Staff Augmentation logo

Bacancy - Staff Augmentation

Leave your web app development hustles to the leading IT Staff Augmentation Service Providers. Choose from an extensive pool of 1050+ developers and give yourself the sigh of success you deserve with Bacancy. Get In Touch Today!

Bacancy - Staff Augmentation
DocuWriter.ai logo

DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

DocuWriter.ai
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
October CMS v3.6 Ships Today, Full of New Features image

October CMS v3.6 Ships Today, Full of New Features

Read article
Laracon EU Videos are now out image

Laracon EU Videos are now out

Read article
Use Google's Gemini AI in Laravel image

Use Google's Gemini AI in Laravel

Read article
PhpStorm is getting a brand new terminal image

PhpStorm is getting a brand new terminal

Read article
Six Essential Plugins for Visual Studio Code image

Six Essential Plugins for Visual Studio Code

Read article
Modularize Your Laravel Application With the Modular Package image

Modularize Your Laravel Application With the Modular Package

Read article