A data object will automatically be transformed to a JSON response when returned in a controller:
class SongController
{
public function show(Song $model)
{
return SongData::from($model);
}
}
{
"name": "Never gonna give you up",
"artist": "Rick Astley"
}
Collections
Returning a data collection from the controller:
SongData::collect(Song::all());
[
{
"name": "Never Gonna Give You Up",
"artist": "Rick Astley"
},
{
"name": "Giving Up on Love",
"artist": "Rick Astley"
}
]
Paginators
It is also possible to provide a paginator:
SongData::collect(Song::paginate());
{
"data": [
{
"name": "Never Gonna Give You Up",
"artist": "Rick Astley"
},
{
"name": "Giving Up on Love",
"artist": "Rick Astley"
}
],
"meta": {
"current_page": 1,
"first_page_url": "https://spatie.be/?page=1",
"from": 1,
"last_page": 7,
"last_page_url": "https://spatie.be/?page=7",
"next_page_url": "https://spatie.be/?page=2",
"path": "https://spatie.be/",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 100
}
}
{
"name": null,
"artist": null
}
class SongsController
{
public function create(): array
{
return SongData::empty();
}
}
Default Values
You can provide default values in the constructor:
class SongData extends Data
{
public function __construct(
public string $title = 'Title of the song here',
public string $artist = "An artist",
) {
}
}
empty call:
SongData::empty([
'name' => 'Title of the song here',
'artist' => 'An artist'
]);
SongData::empty(only: ['name']); // Will only return the `name` property
SongData::empty(except: ['name']); // Will return the `artist` property
Response Status Code
When a resource is returned from a controller, the status code will automatically be set to 201 CREATED when Laravel Data detects that the request’s method is POST. In all other cases, 200 OK will be returned.
Resource Classes
To make it clearer that a data object is a resource, you can use the Resource class instead of the Data class:
use Spatie\LaravelData\Resource;
class SongResource extends Resource
{
public function __construct(
public string $title,
public string $artist,
) {
}
}
Resource classes won’t validate data or check authorization. They are only used to transform data which makes them faster.