naoray / nova-json

Nova json field to spread a json column throughout multiple fields.

Stars
5

nova-json

Software License
Total Downloads
Tests

The JSON field wrapper allows you to specify multiple fields which will be resolved into a single model attribute. This allows you to validate every information you store inside a json column seperately.

JSON::make('Author', [
    Text::make('Name')->rules(['string', 'required', 'min:3']),
    Text::make('Email')->rules(['email', 'required']),
])

The above will be resolved into a single author attribute on the model.

// prequesite: the 'author' attribute needs to casted into a json castable type
// e.g. object, array, ...
['author' => ['name' => '', 'email' => '']]

Install & setup

composer require naoray/nova-json

Add the column's name, you want to use in the JSON field, to your $casts array on the resource's model!

Usage

You can destructure one JSON column into multiple Nova fields and apply unique rules to each of the key-value pairs.

use Naoray\NovaJson\JSON;

// within your nova resource
public function fields()
{
    return [
        //...
        JSON::make('Some Json Column Name', [
            Text::make('First Field'),
            Text::make('Second Field'),
            Text::make('Third Field'),
        ]);
    ]
}

FillUsing callbacks

The ->fillUsing() callbacks are normally used to fill the models attribute directly. With this package, it's not necessary to fill the model's attribute, but instead you should return the value you want to save on the model itself.

JSON::make('Address', 'address', [
    Text::make('Street')->fillUsing(fn ($request, $model, $attribute, $requestAttribute) => $request[$requestAttribute] . ' Foo'),
]);

The above example is rather silly than useful, but it demonstrates the concept. The _ Foo_ value will be apended to every address->street value within nova.

Fill at once

When using data transfer objects (which works well with castable dto's) you don't want each field to be filled seperately, because than the dto's validation is useless. With the fillAtOnce() method a Hidden field will be added and the filling of single fields will be avoided. Instead all values will be filled at once via the Hidden field.

JSON::make('Address', 'address', [
    Text::make('Street'),
    Text::make('City'),
])->fillAtOnce();

The fillOnce() method accepts a Callback which can be used to modify the data structure before it is added to the model.

// given these fields:
JSON::make('Address', 'address', [
    Text::make('Street'),
    Text::make('City'),
])->fillAtOnce(function ($request, $requestValues, $model, $attribute, $requestAttribute) {
    return ['nested' => $requestValues];
});

// and a request with ['address->street' => 'test str. 5', 'address->city' => 'test city']

// we will get
$requestValues = ['street' => 'test str. 5', 'city' => 'test city'];

// which will be pased into the fillAtOnce callback leading to the following in our db:
['address' => ['nested' => ['street' => 'test str. 5', 'city' => 'test city']]];

Use inside Panels

In order to use JSON column inside Nova Panel you need to get 'data' property of the top level JSON field.

Examples

  1. JSON is the only field inside Panel
new Panel('Brand Settings', 
    JSON::make('brand_settings', [
        Image::make('Logo')->disk('public'),
        Color::make('Primary Color')->swatches(),
        Color::make('Secondary Color')->swatches(),
    ])->data,
),
  1. if you need other fields inside the Panel you can use splat operator like this:
new Panel('Brand Settings', [
    Text::make('Some Field'),
    ...JSON::make('brand_settings', [
        Image::make('Logo')->disk('public'),
        Color::make('Primary Color')->swatches(),
        Color::make('Secondary Color')->swatches(),
    ])->data,
]),

Labels & Attributes

By default the first argument you provide the JSON field will be considered its name. If you don't provide a second string argument the attribute of the field will be guessed e.g. 'Some Json Column Name' => 'some_json_column_name'. If you want your field name to be different from your attribute you can provide the field with a second argument and provide the fields as the third argument: JSON::make('Some Name', 'column_name', [])

Nested Structures

The JSON field can also be nested by itself to display nested JSON structures:

JSON::make('Meta', [
    Text::make('Street'),

    JSON::make('Location', [
        Text::make('Latitude'),
        Text::make('Longitude'),
    ]),
]);

Testing

Run the tests with:

vendor/bin/phpunit

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

License

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