Database relations

CrudAdmin automates the relations between models. It designs the relational database, generates an interface that supports the relations, and binds the relation methods of the models.

Tree structured models

A child admin model is attached to its parent with $belongsToModel. The parent form then shows a nested module for the child records, and the foreign keys and relations are created automatically.

app/Models/OrdersItem.php

class OrdersItem extends AdminModel
{
    protected $belongsToModel = Order::class;
}

Parent models, recursive trees, children created before the parent and relations to any model are described in Tree, ordering and publishing.

Relations in a field

Two independent modules, each in its own place in the administration, are linked through fields. A record is linked to one record of another table with belongsTo, or to several records with belongsToMany.

app/Models/Article.php

public function fields()
{
    return [
        'name' => 'name:Article name|required',
        'author' => 'name:Author|belongsTo:authors,name',
        'tags' => 'name:Tags|belongsToMany:tags,name',
    ];
}

Relation fields, their options, filters and buttons are described in Relation fields. Laravel requires relationship methods on the model to select related records. CrudAdmin maps the models to each other based on the fields and the tree structure, so you do not have to write these methods. Defining your own relations in the model is still possible when you need it.

Selecting a relation in a tree structure

This example works with an order that contains several ordered items.

app/Models/Order.php

class Order extends AdminModel
{
    public function fields()
    {
        return [
            'number' => 'name:Order number|required',
        ];
    }
}

The ordered item module, attached to a single order:

app/Models/OrdersItem.php

class OrdersItem extends AdminModel
{
    protected $belongsToModel = Order::class;

    public function fields()
    {
        return [
            'name' => 'name:Product name|required',
        ];
    }
}

Selecting the items of an order:

$order = Order::find(1);

$items = $order->items()->get(); // New query
$items = $order->items; // New query
$items = $order->items; // Cached result

Selecting the order of an item:

$item = OrdersItem::first();

$order = $item->order;

// With your own query rules
$order = $item->order()->select(['number'])->first();

Selecting a relation assigned in a field

app/Models/Article.php

class Article extends AdminModel
{
    public function fields()
    {
        return [
            'name' => 'name:Article name|required',
            'author' => 'name:Author|belongsTo:authors,name',
            'tags' => 'name:Tags|belongsToMany:tags,tagname',
        ];
    }
}

$article = Article::find(1);

// Author of the article, belongsTo relation
$author = $article->author;

// All tags of the article, belongsToMany relation
$tags = $article->tags;

// Pivot rows of the tags relation
$pivot = $article->tags_pivot;

// All articles of the author, reverse relation named by the plural model name
$articles = $author->articles;

Relations are bound automatically as long as the relation fields are correct and the English plural is used for reverse relations.

Getting started

Upgrade guide

Admin interface

Validation

Frontend

Website

Database relations

Tree structured models

Relations in a field

Selecting a relation in a tree structure

Selecting a relation assigned in a field

​Tree structured models

​Relations in a field

​Selecting related records

​Selecting a relation in a tree structure

​Selecting a relation assigned in a field

Tree structured models

Relations in a field

Selecting related records

Selecting a relation in a tree structure

Selecting a relation assigned in a field