Eloquent Table as Controller

You can use any Eloquent Table directly as a controller. You don't even need to create a Blade file for it. Create your Eloquent Table as normal and register it as a GET route.

<?php
// app/Tables/UserTable.php

declare(strict_types=1);

namespace App\Tables;

use App\Models\User;
use Illuminte\Http\Request;
use BrickNPC\EloquentTables\Table;

class UserTable extends Table
{
    //... Configuration
}

<?php
// routes/web.php

Route::get('/users', App\Tables\UserTable::class);

Your table is now available at /users.

Layout

To render the Table inside your own layout file, you can configure the table to use a custom layout. There are two ways to do this, via an attribute or a method.

Attribute

If you just want to use a custom layout for all tables, you can set the Layout attribute on the Table class. You can also set which section the table should be rendered in (defaults to slot in case your layout is a component), and you can also add any additional data to the layout via the with property.

<?php
// app/Tables/UserTable.php

declare(strict_types=1);

namespace App\Tables;

use App\Models\User;
use Illuminte\Http\Request;
use BrickNPC\EloquentTables\Table;
use BrickNPC\EloquentTables\Attributes\Layout;

#[Layout(name: 'layouts.app', section: 'content', with: ['foo' => 'bar'])]
class UserTable extends Table
{
    //... Configuration
}

Method

The layout method must return the same Layout attribute as the attribute above. The only difference is that you have some more flexibility in defining the layout, as you are inside a method and therefore can use code to populate the with array for instance.

<?php
// app/Tables/UserTable.php

declare(strict_types=1);

namespace App\Tables;

use App\Models\User;
use Illuminte\Http\Request;
use BrickNPC\EloquentTables\Table;
use BrickNPC\EloquentTables\Attributes\Layout;

class UserTable extends Table
{
    //... Configuration
    
    public function layout(): Layout
    {
        return new Layout(
            name: 'layouts.app', 
            section: 'content', 
            with: ['foo' => 'bar'], 
        );
    }
}

Dependency injection

The layout method supports dependency injection, meaning you can typehint any object in the layout method and the Eloquent Tables package will inject that dependency into your method.

<?php
// app/Tables/UserTable.php
declare(strict_types=1);

namespace App\Tables;

use App\Models\User;
use BrickNPC\EloquentTables\Table;
use BrickNPC\EloquentTables\Attributes\Layout;

class UserTable extends Table
{
    public function layout(MyService $service, AnotherService $another): Layout
    {
        return new Layout('layout');
    }
}

Route model binding

The layout method also supports Route Model Binding in the same way controller methods do. You can typehint any Laravel Model in your layout method, and as long as the name of the parameter is the same as the name of the route parameter, the Eloquent Tables package will load the model from the database and inject it into your layout method.

<?php
// routes/web.php

//... Other Route definitions
Route::get('{team}/users', App\Tables\UserTable::class);

<?php
// app/Tables/UserTable.php
declare(strict_types=1);

namespace App\Tables;

use App\Models\Team;
use App\Models\User;
use BrickNPC\EloquentTables\Table;
use BrickNPC\EloquentTables\Attributes\Layout;

class UserTable extends Table
{
    public function layout(Team $team): layout
    {
        return new Layout('layout')->with('title', __('Team :name users', ['name' => $team->name]));
    }
}

Navigating to http://my-app.test/1/users will automatically try to load the Team with ID 1 and inject it into the layout method. If there is no team with the given key, a 404 model not found exception is thrown just like for normal route model binding in Laravel.