Laravel Data

https://spatie.be/docs/laravel-data/v4
Admin
Laravel Data is a package for Laravel that enables the creation of rich data objects, simplifying...
Tokens:84,921
Snippets:828
Trust Score:9.9
Update:5 hours ago
Show doc for...
Tokens:
Raw
### Install spatie/laravel-data via Composer

Source: https://spatie.be/docs/laravel-data/v4/installation-setup

Run this command to install the package. It is the first step in setting up Laravel Data.

```bash
composer require spatie/laravel-data
```

--------------------------------

### Output of toArray example

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/from-data-to-array

Example output array from the toArray call, showing the structure with 'name' and 'artist' keys.

```php
[
    'name' => 'Never gonna give you up',
    'artist' => 'Rick Astley'
]
```

--------------------------------

### Example empty object JSON

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/from-data-to-resource

A blueprint for creating a new model, showing the required data with null values.

```json
{
    "name": null,
    "artist": null
}
```

--------------------------------

### Example POST request data

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/request-to-data-object

Example JSON payload sent to an endpoint to create a SongData object.

```json
{
    "title" : "Never gonna give you up",
    "artist" : "Rick Astley"
}
```

--------------------------------

### Providing arguments to WithCastable

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/creating-a-cast

Example showing how to pass arguments to the WithCastable attribute. The arguments are passed to the dataCastUsing method.

```php
class DuplicateEmailCheck extends Data
{
    public function __construct(
        #[WithCastable(Email::class, normalize: true)]
        public Email $email,
    ) {
    }
}
```

--------------------------------

### Output of collection toArray example

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/from-data-to-array

Example output array from transforming a collection of data objects, showing an array of associative arrays.

```php
[
    [
        "name": "Never Gonna Give You Up",
        "artist": "Rick Astley"
    ],
    [
        "name": "Giving Up on Love",
        "artist": "Rick Astley"
    ] 
]
```

--------------------------------

### Providing parameters to casts

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/casts

Example of passing parameters to a cast attribute.

```php
#[WithCast(EnumCast::class, type: Format::class)]
public Format $format
```

--------------------------------

### Image class constructor

Source: https://spatie.be/docs/laravel-data/v4/getting-started/quickstart

An example Image class with a constructor that accepts a file string and an integer size. This class is used to demonstrate creating a local cast.

```php
class Image
{
    public function __construct(
        public string $file,
        public int $size,
    ) {
    }
}
```

--------------------------------

### Get the first item in a DataCollection

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections

Shows how to use the first method on a DataCollection to retrieve the first item, returning a SongData object.

```php
SongData::collect(Song::all(), DataCollection::class)->first(); // SongData object
```

--------------------------------

### Referencing root fields with FieldReference

Source: https://spatie.be/docs/laravel-data/v4/validation/using-validation-attributes

Shows how to reference a field starting from the root data object using the FieldReference class with fromRoot: true.

```php
class SongData extends Data
{
    public function __construct(
        public string $title,
        #[RequiredIf(new FieldReference('album_name', fromRoot: true), 'Whenever You Need Somebody')]
        public string $artist,
    ) {
    }
}
```

--------------------------------

### One-time include example

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/lazy-properties

Shows that calling include('songs') affects only that specific transformation; subsequent toArray() calls do not include songs.

```php
AlbumData::from(Album::first())->include('songs')->toArray(); // will include songs
AlbumData::from(Album::first())->toArray(); // will not include songs
```

--------------------------------

### Rules method with dependency injection

Source: https://spatie.be/docs/laravel-data/v4/validation/manual-rules

Add dependencies to be automatically injected into the rules method. The example injects SongSettingsRepository and uses it to conditionally apply RequiredIf based on user settings.

```php
use SongSettingsRepository;

class SongData extends Data
{
    public function __construct(
        public string $title,
        public string $artist,
    ) {
    }
    
    public static function rules(SongSettingsRepository $settings): array
    {
        return [
            'title' => [new RequiredIf($settings->forUser(auth()->user())->title_required), new StringType()],
            'artist' => [new Required(), new StringType()],
        ];
    }
}
```

--------------------------------

### Inject CreationContext into a magical method

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/factories

Shows how to inject the creation context into a magical method by adding it as a parameter. The context is used automatically when using the from method, but can be used manually. The example defines a fromModel method that receives a Song model and a CreationContext.

```php
class SongData extends Data
{
    public function __construct(
        public string $title,
        public string $artist,
    ) {
    }
    
    public static function fromModel(Song $song, CreationContext $context): self
    {
        // Do something with the context
    }
}
```

--------------------------------

### Auto Lazy Inertia Properties with Attributes

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/use-with-inertia

Rewrites the previous example using auto-lazy attributes: AutoInertiaLazy, AutoClosureLazy, and AutoInertiaDeferred on properties.

```php
use Spatie\LaravelData\Attributes\AutoClosureLazy;
use Spatie\LaravelData\Attributes\AutoInertiaLazy;
use Spatie\LaravelData\Attributes\AutoInertiaDeferred;

class SongData extends Data
{
    public function __construct(
        #[AutoInertiaLazy]
        public Lazy|string $title,
        #[AutoClosureLazy]
        public Lazy|string $artist,
        #[AutoInertiaDeferred]
        public Lazy|string $lyrics,
    ) {
    }
}
```

--------------------------------

### Implement a custom normalizer

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/normalizers

Example of a normalizer that implements the Normalizer interface. It returns an array representation of the payload or null if it cannot normalize the value.

```php
class ArrayableNormalizer implements Normalizer
{
    public function normalize(mixed $value): ?array
    {
        if (! $value instanceof Arrayable) {
            return null;
        }

        return $value->toArray();
    }
}
```

--------------------------------

### Data class implementing Wireable with WireableData trait

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/use-with-livewire

Shows the required modifications to a data class to work with Livewire: implement Wireable and use the WireableData trait. This is the updated version of the previous example.

```php
class SongData extends Data implements Wireable
{
    use WireableData;

    public function __construct(
        public string $title,
        public string $artist,
    ) {
    }
}
```

--------------------------------

### Inject dependency with additional parameters using FromContainer

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/injecting-property-values

When the dependency requires additional parameters, provide them using the 'parameters' argument of the FromContainer attribute. The example passes the 'year' parameter with value 1984.

```PHP
class SongData extends Data {
    #[FromContainer(SongService::class, parameters: ['year' => 1984])]
    public SongService $song_service;
}
```

--------------------------------

### Create collection from Eloquent collection with SongData::collect

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections

Pass an Eloquent collection to SongData::collect to get an Eloquent collection of SongData objects. The package returns the same collection type as the input.

```php
SongData::collect(Song::all()); // return an Eloquent collection of SongData objects
```

--------------------------------

### Define a simple SongData class

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object

Defines a basic data object with a constructor that accepts title and artist properties. This is the starting point for creating data objects.

```php
class SongData extends Data
{
    public function __construct(
        public string $title,
        public string $artist,
    ) {
    }
}
```

--------------------------------

### Define fromMultiple method to create SongData from multiple arguments

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object

Add a static `fromMultiple` method that accepts multiple arguments. The example passes title and artist separately. Then `SongData::from('Never gonna give you up', 'Rick Astley')` uses this method.

```php
class SongData extends Data
{
    public function __construct(
        public string $title,
        public string $artist,
    ) {
    }
    
    public static function fromMultiple(string $title, string $artist): self
    {
        return new self($title, $artist);
    }
}
```

```php
SongData::from('Never gonna give you up', 'Rick Astley');
```

--------------------------------

### Validating data object with original name

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/mapping-rules

When validating a data object or getting rules, always use the original name. The example shows an array with 'favorite_song' and 'title', then calls validate and getValidationRules.

```php
$data = [
    'favorite_song' => 123,
    'title' => 'some title',
];

UserData::validate($data)
UserData::getValidationRules($data)
```

--------------------------------

### Instantiate Singer and Musician individually

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/abstract-data

Shows how to create instances of the subclasses using the from method with an array of properties. This works because each subclass is concrete.

```php
Singer::from(['name' => 'Rick Astley', 'voice' => 'tenor']);
Musician::from(['name' => 'Rick Astley', 'instrument' => 'guitar']);
```

--------------------------------

### Create a data object using the magical fromMultiple method

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object.md

Shows how to create a SongData instance by passing multiple arguments to the from method, which internally calls the fromMultiple method.

```php
SongData::from('Never gonna give you up', 'Rick Astley');
```

--------------------------------

### Enable Livewire Synths in data.php config

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/use-with-livewire

Configuration option to enable experimental Livewire Synths. Set 'enable_synths' to true to use data objects without Wireable. This feature is experimental and subject to change.

```php
'livewire' => [
    'enable_synths' => false,
]
```

--------------------------------

### Adding a rule of the same kind replaces previous

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/creating-a-rule-inferrer

When adding a rule of the same kind, the previous version is removed. The example shows adding two Min rules and then retrieving all rules, which results in only the latest Min rule.

```php
$rules->add(new Min(42));
$rules->add(new Min(314)); 

$rules->all(); // [new Min(314)]
```

--------------------------------

### Example data object with complex types

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/casts

Base example of a data object with a DateTime and an Enum property that require casts.

```php
class SongData extends Data
{
    public function __construct(
        public string $title,
        public string $artist,
        public DateTime $date,
        public Format $format,
    ) {
    }
}
```

```php
enum Format: string {
    case cd = 'cd';
    case vinyl = 'vinyl';
    case cassette = 'cassette';
}
```

```php
SongData::from([
    'title' => 'Never gonna give you up',
    'artist' => 'Rick Astley',
    'date' => '27-07-1987',
    'format' => 'vinyl',
]);
```

--------------------------------

### Create a data object using the magical fromString method

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object.md

Shows how to create a SongData instance by passing a single string to the from method, which internally calls the fromString method.

```php
SongData::from('Never gonna give you up|Rick Astley');
```

--------------------------------

### Create a CursorPaginatedCollection

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections

Shows how to create a CursorPaginatedCollection using SongData::collect with the CursorPaginatedCollection::class.

```php
use Spatie\LaravelData\CursorPaginatedCollection;

SongData::collect(Song::cursorPaginate(), CursorPaginatedCollection::class);
```

--------------------------------

### Get data object from a model

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/get-data-from-a-class-quickly

Call getData() on a model instance to get the corresponding data object. The comment shows the expected return type.

```php
Song::firstOrFail($id)->getData(); // A SongData object
```

--------------------------------

### Create a DataCollection

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections

Shows how to create a DataCollection using SongData::collect with the DataCollection::class. This is one of the collection classes provided by the package.

```php
use Spatie\LaravelData\DataCollection;

SongData::collect(Song::all(), DataCollection::class);
```

--------------------------------

### Instantiate SongData with constructor

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object

Creates a new SongData instance using the constructor with title and artist values.

```php
new SongData('Never gonna give you up', 'Rick Astley');
```

--------------------------------

### Get wrapped array with wrap() and WrapExecutionType::Enabled

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/wrapping

Use `wrap('data')` with `WrapExecutionType::Enabled` to get a wrapped array, overriding the default behavior of `toArray` and `toJson` which never wrap.

```php
SongData::from(Song::first())->wrap('data')->transform(wrapExecutionType: WrapExecutionType::Enabled);
```

--------------------------------

### Anonymous class castable example

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/creating-a-cast

Complete example of a value object implementing Castable, returning an anonymous class that implements Cast from its dataCastUsing method. This allows defining the value object and its casting logic together.

```php
<?php
namespace Spatie\LaravelData\Tests\Fakes\Castables;

use Spatie\LaravelData\Casts\Cast;
use Spatie\LaravelData\Casts\Castable;
use Spatie\LaravelData\Support\Creation\CreationContext;
use Spatie\LaravelData\Support\DataProperty;

class Email implements Castable
{
  public function __construct(public string $email) {

  }

  public static function dataCastUsing(...$arguments): Cast
  {
    return new class implements Cast {
        public function cast(DataProperty $property, mixed $value, array $properties, CreationContext $context): mixed
        {
            return new Email($value);
        }
    };
  }
}
```

--------------------------------

### Create a PaginatedDataCollection

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections

Shows how to create a PaginatedDataCollection using SongData::collect with the PaginatedDataCollection::class.

```php
use Spatie\LaravelData\PaginatedDataCollection;

SongData::collect(Song::paginate(), PaginatedDataCollection::class);
```

--------------------------------

### Get data object without transforming using all method

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/transformers

Calls the all method on a data object to get an array representation without transforming properties. Carbon objects remain as objects, and nested data objects and DataCollections are not converted to arrays.

```php
ArtistData::from($artist)->all();
```

--------------------------------

### Configure directories for data discovery

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/performance

Specify directories to search for data objects. Default is app/data, searched recursively.

```php
'structure_caching' => [
    'directories' => [
        app_path('Data'),
    ],
],
```

--------------------------------

### Configure reflection discovery base path and root namespace

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/performance

Set base path and root namespace for reflection discovery when using non-standard directory structure or namespace.

```php
'structure_caching' => [
    'reflection_discovery' => [
        'enabled' => true,
        'base_path' => base_path(),
        'root_namespace' => null,
    ],
],
```

--------------------------------

### SongData data object

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object

Defines a data object for Song with id and title properties. Used in the relations example.

```php
class SongData extends Data
{
    public int $id;
    public string $title;
}
```

--------------------------------

### Create a data object with prepared payload

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/pipeline

Shows how to instantiate a data object from an array after using prepareForPipeline. The input array contains flat keys that are transformed into a nested structure.

```php
$songData = SongData::from([
    'title' => 'Never gonna give you up',
    'release_year' => '1987',
    'producer' => 'Stock Aitken Waterman',
]);
```

--------------------------------

### Song model with BelongsTo relation

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object

Defines a Song model with a belongsTo relation to Artist. This is part of the relations example.

```php
class Song extends Model
{
    public function artist(): BelongsTo
    {
        return $this->belongsTo(Artist::class);
    }
}
```

--------------------------------

### Casting arrays of non-data types

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/casts

Example of a data object with an array of DateTime objects, enabled by the cast_and_transform_iterables feature.

```php
class ReleaseData extends Data
{
    public string $title;
    /** @var array<int, DateTime> */
    public array $releaseDates;
}
```

```php
'features' => [
    'cast_and_transform_iterables' => true,
],
```

```php
ReleaseData::from([
    'title' => 'Never Gonna Give You Up',
    'releaseDates' => [
        '1987-07-27T12:00:00Z',
        '1987-07-28T12:00:00Z',
        '1987-07-29T12:00:00Z',
    ],
]);
```

--------------------------------

### Creating an author and transforming to data

Source: https://spatie.be/docs/laravel-data/v4/getting-started/quickstart

Create an author with a post and then transform it to `AuthorData` using `AuthorData::from($author)`. Note the source has a syntax error in the `posts()->create` call (extra brackets).

```php
$author = Author::create([
    'name' => 'Ruben Van Assche'
]);

$author->posts()->create([        
    [
        'title' => 'Hello laravel-data',
        'content' => 'This is an introduction post for the new package',
        'status' => 'draft',
        'published_at' => null,
    ]
]);

AuthorData::from($author);
```

--------------------------------

### Looping over a DataCollection with foreach

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections

Shows how to iterate over a DataCollection using a foreach loop to access each item's properties.

```php
foreach ($songs as $song){
    echo $song->title;
}
```

--------------------------------

### Artist model with attribute

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object

Defines a fullName attribute using Laravel's Attribute::make with a get callback.

```php
class Artist extends Model
{
    protected function fullName(): Attribute
    {
        return Attribute::make(
            get: fn () => $this->first_name . ' ' . $this->last_name,
        );
    }
}
```

--------------------------------

### Empty blueprint JSON array

Source: https://spatie.be/docs/laravel-data/v4/getting-started/quickstart

Example of the empty blueprint array returned by `PostData::empty()`, with all fields set to null.

```json
{
    "title" : null,
    "content" : null,
    "status" : null,
    "image": null,
    "published_at" : null
}
```

--------------------------------

### Artist model with HasMany relation

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object

Updates the Artist model to include a hasMany relation to Song. This is part of the relations example.

```php
class Artist extends Model
{
    public function songs(): HasMany
    {
        return $this->hasMany(Song::class);
    }
}
```

--------------------------------

### Basic Artist model

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object

A minimal Eloquent model with no custom logic, used as the starting point for creating a data object.

```php
class Artist extends Model
{
    
}
```

--------------------------------

### Attempt to create Contract instances with different artist subclasses

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/abstract-data

Shows two valid attempts to create Contract instances, but the package cannot determine which subclass to use for the artist property without additional configuration.

```php
Contract::from(['label' => 'PIAS', 'artist' => ['name' => 'Rick Astley', 'voice' => 'tenor']]);
Contract::from(['label' => 'PIAS', 'artist' => ['name' => 'Rick Astley', 'instrument' => 'guitar']]);
```

--------------------------------

### Large author list JSON

Source: https://spatie.be/docs/laravel-data/v4/getting-started/quickstart

Example of a large JSON payload with authors and their posts, illustrating the problem lazy properties solve.

```json
[
    {
        "name" : "Ruben Van Assche",
        "posts" : [
            {
                "title" : "Hello laravel-data",
                "content" : "This is an introduction post for the new package",
                "status" : "published",
                "image" : "http://laravel-playbox.test/images/8JQtgd0XaPtt9CqkPJ3eWFVV4BAp6JR9ltYAIKqX.png",
                "published_at" : "2021-09-24T13:31:20+00:00"
            }

            // ...
        ]
    },
    {
        "name" : "Freek van der Herten",
        "posts" : [
            {
                "title" : "Hello laravel-event-sourcing",
                "content" : "This is an introduction post for the new package",
                "status" : "published",
                "image" : "http://laravel-playbox.test/images/8JQtgd0XaPtt9CqkPJ3eWFVV4BAp6JR9ltYAIKqX.png"
                "published_at" : "2021-09-24T13:31:20+00:00"
            }

            // ...
        ]
    }

    // ...
]
```

--------------------------------

### Using SongData::from($request)

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/request-to-data-object

Alternative approach: pass the request to the from method, which also validates the request data.

```php
class UpdateSongController
{
    public function __invoke(
        Song $model,
        SongRequest $request
    ){
        $model->update(SongData::from($request)->all());
        
        return redirect()->back();
    }
}
```

--------------------------------

### Create a data object with a collection of data objects

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections

Shows how to define an AlbumData class with a Collection property and use AlbumData::from to create it from an array. The package automatically converts the array into a collection of data objects.

```php
use App\Data\SongData;
use Illuminate\Support\Collection;

class AlbumData extends Data
{    
    public string $title;
    /** @var Collection<int, SongData> */
    public Collection $songs;
}

AlbumData::from([
    'title' => 'Never Gonna Give You Up',
    'songs' => [
        ['title' => 'Never Gonna Give You Up', 'artist' => 'Rick Astley'],
        ['title' => 'Giving Up on Love', 'artist' => 'Rick Astley'],
    ]
]);
```

--------------------------------

### Create Artist with data objects

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/eloquent-casting

Creates an Artist record with an array of SongData objects for the 'songs' attribute.

```php
Artist::create([
    'songs' => [
        new SongData(title: 'Never gonna give you up', artist: 'Rick Astley'),
        new SongData(title: 'Together Forever', artist: 'Rick Astley'),
    ],
]);
```

--------------------------------

### Creating Nested Data Object with Constructor

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/nesting

Shows how to instantiate a nested data object using the constructor, passing an ArtistData instance as an argument.

```php
new AlbumData(
    'Never gonna give you up',
    new ArtistData('Rick Astley', 22)
);
```

--------------------------------

### Define a data class with a regular collection property

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/lazy-properties

Example of a data class where the songs property is always included in the output, which can become large.

```php
class AlbumData extends Data
{
    /**
    * @param Collection<int, SongData> $songs
    */
    public function __construct(
        public string $title,
        public Collection $songs,
    ) {
    }
}
```

--------------------------------

### Create Artist with null songs and access collection

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/eloquent-casting

Creates an Artist with a null 'songs' attribute and shows that accessing it returns an empty DataCollection.

```php
$artist = Artist::create([
    'songs' => null
]);

$artist->songs; // DataCollection
$artist->songs->count();// 0
```

--------------------------------

### Allow all properties for includes

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/lazy-properties

Allows all properties to be included via query string by returning null.

```php
class UserData extends Data
{
    public static function allowedRequestIncludes(): ?array
    {
        return null;
    }
}
```

--------------------------------

### Output of nested data object to array

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/from-data-to-array

Example output array when a nested data object is transformed to an array, showing the nested structure.

```php
[
    "name": "Ruben",
    "email": "ruben@spatie.be",
    "favorite_song": [
        "name" : "Never Gonna Give You Up",
        "artist" : "Rick Astley"
    ]
]
```

--------------------------------

### Define abstract data object and child classes

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/eloquent-casting

Example of an abstract data object with two child classes for different record types.

```php
abstract class RecordConfig extends Data
{
    public function __construct(
        public int $tracks,
    ) {}
}

class CdRecordConfig extends RecordConfig
{
    public function __construct(
        int $tracks,
        public int $bytes,
    ) {
        parent::__construct($tracks);
    }
}

class VinylRecordConfig extends RecordConfig
{
    public function __construct(
        int $tracks,
        public int $rpm,
    ) {
        parent::__construct($tracks);
    }
}
```

--------------------------------

### Generate a data object with make:data

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/commands

Run this artisan command to create a new data object named PostData in the default App\Data namespace.

```bash
php artisan make:data PostData
```

--------------------------------

### Nullable nested ArtistData

Source: https://spatie.be/docs/laravel-data/v4/validation/nesting-data

Example data class with a nullable nested ArtistData object. The validation rules change depending on whether a value is provided.

```php
class AlbumData extends Data
{
    public function __construct(
        public string $title,
        public ?ArtistData $artist,
    ) {
    }
}
```

--------------------------------

### Example data class with typed properties

Source: https://spatie.be/docs/laravel-data/v4/validation/auto-rule-inferring

A data class with string, int, and nullable string properties. The package infers validation rules from these types.

```php
class ArtistData extends Data{
    public function __construct(
        public string $name,
        public int $age,
        public ?string $genre,
    ) {
    }
}
```

--------------------------------

### Validate and create with SongData::validateAndCreate

Source: https://spatie.be/docs/laravel-data/v4/validation/introduction

Validates data and creates the object after successful validation. Returns a SongData object.

```php
SongData::validateAndCreate(
    ['title' => 'Never gonna give you up', 'artist' => 'Rick Astley']
); // returns a SongData object
```

--------------------------------

### Route definition for my-account

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/lazy-properties

Defines a route that returns a UserData object from the first user. This route is used in the examples to demonstrate query string includes.

```php
// in web.php

Route::get('my-account', fn() => UserData::from(User::first()));
```

--------------------------------

### Nested data object example with UserData

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/from-data-to-array

Shows a data object that contains another data object as a property, with a fromModel method to construct it from a model.

```php
class UserData extends Data
{
    public function __construct(
        public string $title,
        public string $email,
        public SongData $favorite_song,
    ) {
    }
    
    public static function fromModel(User $user): self
    {
        return new self(
            $user->title,
            $user->email,
            SongData::from($user->favorite_song)
        );
    }
}
```

--------------------------------

### Create SongData from a model using fromModel

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object.md

Calls `from` with a model; the custom `fromModel` method is invoked instead of the default.

```php
SongData::from(Song::firstOrFail($id));
```

--------------------------------

### AlbumData with nested ArtistData

Source: https://spatie.be/docs/laravel-data/v4/validation/nesting-data

Example data class with a nested ArtistData object. The validation rules for this class include rules for the nested object's properties.

```php
class AlbumData extends Data
{
    public function __construct(
        public string $title,
        public ArtistData $artist,
    ) {
    }
}
```

--------------------------------

### Example payload for nested data validation

Source: https://spatie.be/docs/laravel-data/v4/validation/manual-rules

A sample payload array that would be provided to the AlbumData object, containing a list of songs with titles and optional artists.

```php
[
    'title' => 'Best songs ever made',
    'songs' => [
        ['title' => 'Never Gonna Give You Up'],
        ['title' => 'Heroes', 'artist' => 'David Bowie'],
    ],
];
```

--------------------------------

### Optional creation with SongData::optional

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object

Use SongData::optional(null) to return null instead of throwing an error. Underneath, it calls the from method when a value is given, so magical creation still works.

```php
SongData::optional(null); // returns null
```

--------------------------------

### MapInputName with SnakeCaseMapper on a property

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object

Use MapInputName on a single property to map a camelCase property name to a snake_case model attribute. The example maps 'fullName' to 'full_name'.

```php
use Spatie\LaravelData\Attributes\MapInputName;
use Spatie\LaravelData\Mappers\SnakeCaseMapper;

class ArtistData extends Data
{
    public int $id;
    #[MapInputName(SnakeCaseMapper::class)]
    public string $fullName;
    public CarbonImmutable $created_at;
    public CarbonImmutable $updated_at;
}
```

--------------------------------

### Disable property name mapping in factory

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/factories

Uses withoutPropertyNameMapping() to prevent automatic mapping of snake_case keys to camelCase properties. In this example, 'record_company' will not be mapped to 'recordCompany'.

```php
ContractData::factory()->withoutPropertyNameMapping()->from(['name' => 'Rick Astley', 'record_company' => 'RCA Records']); // record_company will not be mapped to recordCompany
```

--------------------------------

### Create PostData object with constructor

Source: https://spatie.be/docs/laravel-data/v4/getting-started/quickstart

Instantiate a PostData object directly using its constructor, passing values for title, content, status, and published_at.

```php
$post = new PostData(
    'Hello laravel-data',
    'This is an introduction post for the new package',
    PostStatus::published,
    CarbonImmutable::now()
);
```

--------------------------------

### Livewire component using a data object property

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/use-with-livewire

Shows a Livewire component with a public SongData property, initialized in mount() from a model. Requires the data class to implement Wireable and use the WireableData trait.

```php
class Song extends Component
{
    public SongData $song;

    public function mount(int $id)
    {
        $this->song = SongData::from(Song::findOrFail($id));
    }

    public function render()
    {
        return view('livewire.song');
    }
}
```

--------------------------------

### Injecting dependencies into overwritten validation methods

Source: https://spatie.be/docs/laravel-data/v4/validation/working-with-the-validator

You can type-hint dependencies in methods like attributes() and they will be resolved from the container. This example injects a repository to fetch localized attribute names.

```php
class SongData extends Data
{
    public function __construct(
        public string $title,
        public string $artist,
    ) {
    }

    public static function attributes(
        ValidationAttributesLanguageRepository $validationAttributesLanguageRepository
    ): array
    {
        return [
            'title' => $validationAttributesLanguageRepository->get('title'),
            'artist' => $validationAttributesLanguageRepository->get('artist'),
        ];
    }
}
```

--------------------------------

### Generated validation rules for defaults example

Source: https://spatie.be/docs/laravel-data/v4/validation/introduction

Shows the validation rules generated for the SongData validation call. Only the title rule is present because the artist uses its default value.

```php
[
    'title' => ['required', 'string'],
]
```

--------------------------------

### Livewire component using data object with Synths enabled

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/use-with-livewire

Shows a Livewire component using a data object property without implementing Wireable, enabled by Synths. Includes a Blade view with wire:model.live bindings and a save method.

```php
class SongUpdateComponent extends Component
{
    public SongData $data;

    public function mount(public int $id): void
    {
        $this->data = SongData::from(Song::findOrFail($id));
    }

    public function save(): void
    {
        Artist::findOrFail($this->id)->update($this->data->toArray());
    }

    public function render(): string
    {
        return <<<'BLADE'
        <div>
            <h1>Songs</h1>
            <input type="text" wire:model.live="data.title">
            <input type="text" wire:model.live="data.artist">
            <p>Title: {{ $data->title }}</p>
            <p>Artist: {{ $data->artist }}</p>
            <button wire:click="save">Save</button>
        </div>
        BLADE;
    }
}
```

--------------------------------

### Include all properties with wildcard

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/lazy-properties

Includes all properties of the songs relation using a wildcard.

```php
AlbumData::from(Album::first())->include('songs.*');
```

--------------------------------

### PostData with WithCast attribute

Source: https://spatie.be/docs/laravel-data/v4/getting-started/quickstart

Example PostData class that uses the WithCast attribute to apply the ImageCast to the image property. It also uses the Date attribute for the published_at property.

```php
class PostData extends Data
{
    public function __construct(
        public string $title,
        public string $content,
        public PostStatus $status,
        #[WithCast(ImageCast::class)]
        public ?Image $image,
        #[Date]
        public ?CarbonImmutable $published_at
    ) {
    }
}
```

--------------------------------

### Example JSON payload sent to controller

Source: https://spatie.be/docs/laravel-data/v4/getting-started/quickstart

A sample JSON payload that is sent to the controller to be cast into a PostData object. The published_at field is a string that will be cast to a CarbonImmutable object.

```json
{
    "title" : "Hello laravel-data",
    "content" : "This is an introduction post for the new package",
    "status" : "published",
    "published_at" : "2021-09-24T13:31:20+00:00"
}
```

--------------------------------

### Create data object from model

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object

Creates an ArtistData instance from an Artist model using the static from method.

```php
$artist = ArtistData::from(Artist::find(1));
```

--------------------------------

### Disable magical creation with withoutMagicalCreation

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/factories

Disables all magical creation methods for a factory, so the from method will not use magic methods. The example shows that calling from with a string will not work as expected.

```php
SongData::factory()->withoutMagicalCreation()->from('Never gonna give you up'); // Won't work since the magical method creation is disabled
```

--------------------------------

### Define an Eloquent Song model

Source: https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object

Defines a simple Eloquent model named Song. This model is used in the next example to create a data object from a model instance.

```php
class Song extends Model
{
    // Your model code
}
```

--------------------------------

### Basic only and except usage

Source: https://spatie.be/docs/laravel-data/v4/as-a-resource/lazy-properties

Use `only` to show only the specified property, and `except` to show all except the specified property. These methods take precedence over `include` and `exclude`.

```php
AlbumData::from(Album::first())->only('songs'); // will only show `songs`
AlbumData::from(Album::first())->except('songs'); // will show everything except `songs`
```

--------------------------------

### Using WithCastable attribute

Source: https://spatie.be/docs/laravel-data/v4/advanced-usage/creating-a-cast

Example of using the WithCastable attribute to attach a castable value object class to a data property. The Email class implements the Castable interface.

```php
class ForgotPasswordRequest extends Data
{
    public function __construct(
        #[WithCastable(Email::class)]
        public Email $email,
    ) {
    }
}
```
Tokens:
Raw