laravel-vue-datatable/src/markdown/examples/relationships/introduction.md

Vue.js datatable made with Laravel and Bootstrap in mind

> Add relationships to model

```php
<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use JamesDordoy\LaravelVueDatatable\Traits\LaravelVueDatatableTrait;

class User extends Authenticatable
{
    use Notifiable, LaravelVueDatatableTrait;

    protected $dataTableColumns = [
        'id' => [
            'searchable' => true,
            'orderable' => true,
        ],
        'name' => [
            'searchable' => true,
            'orderable' => true,
        ],
        'email' => [
            'searchable' => true,
            'orderable' => true,
        ],
    ];

    protected $dataTableRelationships = [
        "belongsTo" => [
            ...
        ],
        "hasMany" => [
            ...
        ],
        "belongsToMany" => [
            ...
        ]
    ];
}

```

> BelongsTo

```php
<?php

protected $dataTableRelationships = [
    "belongsTo" => [
        "role" => [
            "model" => \App\Role::class,
            "foreign_key" => "role_id",
            "columns" => [
                "name" => [
                    "searchable" => true,
                    "orderable" => true,
                ],
            ],
        ],
    ],
];
```

> HasMany

```php
<?php

protected $dataTableRelationships = [
    "hasMany" => [
        "telephoneNumbers" => [
            "model" => \App\TelephoneNumber::class,
            "foreign_key" => "user_id",
            "columns" => [
                "name" => [
                    "searchable" => true,
                    "orderable" => true,
                ],
            ],
        ],
    ],
];
```

> BelongsToMany

```php
<?php

protected $dataTableRelationships = [
    "belongsToMany" => [
        "departments" => [
            "model" => \App\Department::class,
            "foreign_key" => "role_id",
            "pivot" => [
                "table_name" => "department_user",
                "primary_key" => "id",
                "foreign_key" => "department_id",
                "local_key" => "user_id",
            ],
            "order_by" => "name",
            "columns" => [
                "name" => [
                    "searchable" => true,
                    "orderable" => true,
                ]
            ],
        ],
    ]
];
```