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.

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
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

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
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

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

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
A Resize Plugin for Alpine.js image

A Resize Plugin for Alpine.js

Read article
How to Migrate MySQL from DBngin to Laravel Herd image

How to Migrate MySQL from DBngin to Laravel Herd

Read article
Learn to master Query Scopes in Laravel image

Learn to master Query Scopes in Laravel

Read article
How to Redirect Uppercase URLs to Lowercase with Laravel Middleware image

How to Redirect Uppercase URLs to Lowercase with Laravel Middleware

Read article
PHP 8.4 Alpha 1 is now out! image

PHP 8.4 Alpha 1 is now out!

Read article
Generics Added to Eloquent Builder in Laravel 11.15 image

Generics Added to Eloquent Builder in Laravel 11.15

Read article