Laravel Content-Administration

# Index Config

Each Crud configuration can have an index page that shows an overview of the models. This index page is configured in the index method of its corresponding config. The first parameter is an instance of Fjord\Page\Page so all functions described in the Fjord Page documentation can be used.

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    // Build your index page here.
}

In the Config for a CRUD model its index table is defined.

# Table

The index table is built using the method table like this:

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    $page->table(function($table) {
        $table->col('Name')->value('{first_name} {last_name}');
    });
}

The table config describes how columns with images, relations and much more can be built.

# Query

In the query method the query for the index table is initialized. Here you have to specify all the relations that should be searchable or to be displayed in the table.

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    $page->table(...)
        ->query(function($query) {
            $query->with('department')
            ->withCount('projects_count');
        });
}

All attributes to be searched for are specified in search. You can also specify relations and their attributes.

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    $page->table(...)->search('title', 'department.name');
}

# Sort

You can sort by all model attributes as well as relations attributes. The sortBy attributes are specified as follows: {attributes}.{desc|asc}. The default attribute to sort by is specified in the sortByDefault method.

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    $page->table(...)->sortByDefault('id.desc');
}

In this example you can see how the array for the sort attributes can look like to sort by id or by a relation.

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    $page->table(...)
        ->sortBy([
            'id.desc' => 'New first',
            'id.asc' => 'Old first',
            'department.name.desc' => 'Department A-Z',
            'department.name.asc' => 'Department Z-A'
        ]);
}

TIP

In case of long loading times when sorted by relation attributes it can help to add an index on the column that connects the relation.

# Filter

Filters are specified in groups. Laravel's model scopes are used to filter the index table as shown in the example:

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    $page->table(...)
        ->filter([
            'Department' => [
                'development' => 'Development',
                'marketing' => 'Marketing',
            ],
        ]);
}

// Model
public function scopeDevelopment()
{
    return $this->hasOne('App\Models\Department')->where('name', 'development');
}

public function scopeMarketing()
{
    return $this->hasOne('App\Models\Department')->where('name', 'marketing');
}

# Pagination

The maximum number of items to be displayed on a page is defined in perPage. The default is 10.

use Fjord\Crud\CrudIndex;

public function index(CrudIndex $page)
{
    $page->table(...)->perPage(5);
}

← Show Config →