keops007/belongs-to-many-field

belongsToMany nova representation in field.

v1.2 2020-05-05 10:14 UTC

Requires

• php: >=7.1.0

MIT

• nova
• laravel
• belongsToMany
• Many to Many Field

README

Inspired from: https://github.com/Benjacho/belongs-to-many-field-nova The initial package did not work with older versions of Nova because of "sortableUriKey" Belongs To Many field to represent many to many relationship in field. This Field allow attaching relationships easily. Also you can:

• Pass query to the multiple select
• Depends on BelongsTo field
• It is available in index, detail and forms!

Installation

composer require keops007/belongs-to-many-field

Usage

In the resource you need to pass:

• Method make ('label', 'many to many relationship function name', 'Nova Resource Relationship')

use Keops007\BelongsToManyField\BelongsToManyField;

public function fields(Request $request){
    return [
        ..., //If you are using with BelongsToMany native Field, put this field after

        BelongsToManyField::make('Role Label', 'roles', 'App\Nova\Role'),
    ];
}

Functions

Function	Param	default	description
optionsLabel	String	'name'	If you don't have column 'name' in your relationship table, use this method. This displays in index and detail Ejm (optionsLabel('full_role_name')).
isAction	Boolean	true	This method is when you need this field in actions, this puts height of field in 350px, and converts in action.
setMultiselectProps	Array	[]	this method allows you to set properties for the vue multiselect component
dependsOn	String, String	null, null	This method allows you to depend on belongsto field, this make an auto query
canSelectAll	String, Boolean	'Select All', true	This method allows you to have a select all checkbox and display custom message

• Method optionsLabel('columnName'), this method is when you don't have column 'name' in your table and you want to label by another column name. By default it tracks by label 'name'.

IMPORTANT

• If you want to label by another column name when displaying in forms, you need to set the title() method on your relationship resource, this method returns an string that is used to label it, also don't forget to add optionsLabel() method to show in detail and index.

use Keops007\BelongsToManyField\BelongsToManyField;

public function fields(Request $request){
    BelongsToManyField::make('Role Label', 'roles', 'App\Nova\Role')->optionsLabel('full_role_name'),
}

• To obtain the data that was sent in action:

public function handle(ActionFields $fields, Collection $models)
{
    //note that roles is the many to many relationship function name
    $values = array_column(json_decode(request()->roles, true),'id');
    
    foreach ($models as $model) {
        $model->roles()->sync($values);
    }
}

• Method setMultiselectProps($props), this method allows you to set properties for the vue multiselect component

     BelongsToManyField::make('Role Label', 'roles', 'App\Nova\Role')
     ->options(\App\Role::all())
     ->setMultiselectProps([
        'selectLabel' => 'click for select',
        // and others from docs
     ]);

• Method dependsOn($dependsOnvalue, $dependsOnKey), This method allows you to depend on belongsto field, this make an auto query

     BelongsTo::make('Association', 'association', 'App\Nova\Association'),

     BelongsToManyField::make('Participants', 'participant', 'App\Nova\Participant')
     ->dependsOn('association', 'association_id'),

• Method canSelectAll($messageSelectAll), This method allows you to display select all checkbox, if you dont pass message default is displayed

     BelongsToManyField::make('Participants', 'participant', 'App\Nova\Participant')
     ->canSelectAll('Seleccionar Todo'),

Validations

This package implement all Laravel Validations, you need to pass the rules in rules method, rules are listed on laravel validations rules for arrays*.

use Keops007\BelongsToManyField\BelongsToManyField;

public function fields(Request $request){
    return [
        ...,
        BelongsToManyField::make('Role Label', 'roles', 'App\Nova\Role')->relationModel(\App\User::class)->rules('required', 'min:1', 'max:5', 'size:3', new CustomRule),
    ];
}

For translations of this validations, use normal laravel validations translations.

Credits to: https://github.com/manmohanjit/nova-belongs-to-dependency

Credits to: https://github.com/Benjacho/belongs-to-many-field-nova