Download the PHP package webfox/laravel-inertia-dataproviders without Composer

Laravel Data Providers for Inertia.js

Data providers encapsulate logic for Inertia views, keep your controllers clean and simple.

Installation

Install this package via composer:

Optionally publish the configuration file:

`

We assume you've already got the Inertia adapter for Laravel installed.

What Problem Does This Package Solve?

Controllers in Laravel are meant to be slim. We have Form Requests to extract our the validation & authorization logic and our display logic is in our views, so why do we still insist on making our controllers handle fetching the data for those views?

This is especially evident in Inertia applications due to the introduction of concepts like lazy and deferred props.

Data providers extract the data composition for your Inertia views into their own classes. Inertia data providers may prove particularly useful if multiple routes or controllers within your application always needs a particular piece of data.

No more 40 line controller methods for fetching data!

Usage

Using a Data Provider

Data providers take advantage of the fact that Inertia::render can accept an Arrayable. They can also be used as discrete attributes in the data array.

What Does a Data Provider Look Like?

Data providers can live anywhere, but we'll use App/Http/DataProviders for this example.

The simplest data provider is just a class that extends DataProvider, any public methods or properties will be available to the page as data.

A full kitchen sink data provider might look like this:

Using Multiple Data Providers

Sometimes you might find yourself wanting to return multiple DataProviders DataProvider::collection is the method for you. Each DataProvider in the collection will be evaluated and merged into the page's data, later values from DataProviders will override earlier DataProviders.

You can also conditionally include DataProviders in the collection:

Or you can use the DataProviderCollection::add method to add a DataProvider to the collection later:

If you need to return the entire dataset as an array, for instance for use in JSON responses, you can use `toNestedArray()

Attribute Name Formatting

The attribute name format can be configured in the configuration file by setting the attribute_name_formatter.
The package ships with three formatters under the namespace \Webfox\InertiaDataProviders\AttributeNameFormatters but you are free to create your own.

AsWritten

This is the default formatter. The output attribute name will be the same as the input name. E.g. a property named $someData and a method named more_data() will be available in the page as someData and more_data.

SnakeCase

This formatter will convert the attribute name to snake_case.
E.g. a property named $someData and a method named more_data() will be available in the page as some_data and more_data.

CamelCase

This formatter will convert the attribute name to camelCase.
E.g. a property named $someData and a method named more_data() will be available in the page as someData and moreData.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

We welcome all contributors to the project.

License

The MIT License (MIT). Please see License File for more information.