Filament•2mo ago

Modify query when loading edit/view form

What is the best way to modify the query when loading an edit or view page? Using soft deletes. So when I select a user in the table, I need to modify the query so that a soft deleted user can be loaded for editing/viewing. Otherwise, nothing is returned. This results in a 404 - Not Found when loading edit / view resource.

Solution:

@awcodes Believe I got it figured out. ```php public static function getEloquentQuery(): Builder
{
if (Auth::user()->hasRole(Roles::SUPER_ADMIN)) { ...

GitHub

Easy way to check the current page inside resource class · filament...

Sometimes we have a different behavior when you are in an edit or creating form using a resource, so for that, we need to identify what is the page that is active at the moment. For example, if we ...

Jump to solution

40 Replies

Matthew•2mo ago

https://filamentphp.com/docs/3.x/tables/filters/ternary#filtering-soft-deletable-records

Ternary filters - Tables - Filament

BatmanOP•2mo ago

@Matthew Thanks for the reply. I already have filters and tabs for the table. The issue arises when you select a user and try to load an edit or view resource page. By default the model query scope excludes soft deleted records. So trying to load a user that is soft deleted by default returns nothing and results in a 404 - Not Found. So I need to be able to modify the query on page load of the edit / view resource.

awcodes•2mo ago

Hmm, I think there’s a fundamental issue here. If a record is soft deleted then it shouldn’t be viewable/exist. that’s kinda the point of soft deletes. If you need to be able to view / edit them then you have to remove the global scope in your resource. In your resource:

public static function getEloquentQuery(): Builder
    {
        return parent::getEloquentQuery()
            ->withoutGlobalScopes([
                SoftDeletingScope::class,
            ]);
    }

public static function getEloquentQuery(): Builder
    {
        return parent::getEloquentQuery()
            ->withoutGlobalScopes([
                SoftDeletingScope::class,
            ]);
    }

Matthew•2mo ago

I think easier than that:

    public static function getEloquentQuery() : Builder
    {
        return parent::getEloquentQuery()->withTrashed();
    }

    public static function getEloquentQuery() : Builder
    {
        return parent::getEloquentQuery()->withTrashed();
    }

However, the point of soft deleting is data safety. You shouldn't have a case where you are consistently wanting to view 'deleted' records. Build a disabled condition into them.

BatmanOP•2mo ago

What I am trying to achieve is the Super Admin has the ability to be able to review/edit and possibly restore the deleted user. I can and have implemented this ability via actions in the table, but would like the SA to be able to review the user and it's audit trail (also using Laravel Auditor and it's Filament package). That's why I am wanting to be able to modify the query and bypass the scope or use withTrashed().

awcodes•2mo ago

Right, but the scope from the resource applies to list, create and edit. If you need to to function differently then you need to override them on each page class. Soft deletes are a global scope so to override them you have disable them.

BatmanOP•2mo ago

Yes, soft deletes are global scopes, but you can also disable or use withTrashed to load soft deleted models. Here is what I am currently doing for the table.

if (Auth::user()->hasRole(Roles::SUPER_ADMIN)) {
    $tabs += ['deleted' => Tab::make('Deleted Users')
      ->modifyQueryUsing(fn ($query) => $query->onlyTrashed()),
  ];
}

if (Auth::user()->hasRole(Roles::SUPER_ADMIN)) {
    $tabs += ['deleted' => Tab::make('Deleted Users')
      ->modifyQueryUsing(fn ($query) => $query->onlyTrashed()),
  ];
}

awcodes•2mo ago

The code I shared is working in our app and allows for the table and edit to work with the TrashedFilter, etc but still allows for individual edit pages with restore and permanent delete actions.

Matthew•2mo ago

Refactor it to mine...it's neater 😆 😆

awcodes•2mo ago

We’re also not using tabs for filtering, so there could be a bug. Just not sure. But tabs only apply to tables right? So if you try to hit posts/1/edit then the query scope still applies and returns a 404. So you have to disable the scope if you need users to be able to actually edit the resource.

BatmanOP•2mo ago

Yes, with the tabs filtering it is providing users in other tabs that should not be there. I could make that work if I can activate it only for the UserResource EditUser & ViewUser. That was why I was trying to figure out if I could modify the query just for those two resource pages. Loading it in a modal work as it's using the tabs scope, but I don't have audit relationship. Yes, tabs only apply to tables outside the caveat of loading view/edit in modal instead of a page (without audit info as stated).

awcodes•2mo ago

What is audit? Sounds like you’re losing track of the context as it relates to policies. I could be wrong. The entire point of the softdeletes trait on models is to prevent anyone for access the record. So if someone needs to access the individual record you have to remove the scope.

BatmanOP•2mo ago

Laravel Auditing - https://laravel-auditing.com/ Laravel Auditing Filament Package- https://filamentphp.com/plugins/tapp-network-laravel-auditing

Laravel Auditing

Laravel Auditing allows you to record changes to an Eloquent model's set of data by simply adding its trait to your model.

Filament

Laravel Auditing by Tapp Network - Filament

Plugin for Laravel Auditing package. Contains a relation manager for audits that you can add to your resources.

awcodes•2mo ago

Ah, so it’s not specific to filament. Maybe reach out to the author of the package.

BatmanOP•2mo ago

Yes, only the Super Admin has access to these records and needs to be able to review the information and audit trail of a soft deleted user. Any other person/role does not have access to them. The auditing is working fine. The issue is loading the soft deleted record in a Filament View/Edit resource (as the audit relationship won't load in modal and there would be too much info for a modal anyway).

awcodes•2mo ago

So, add a check for the SA to disable the scope? If is SA disable the global scope.

BatmanOP•2mo ago

All I want to be able to do is figure out how to modify the query loading the Edit/View (SA only) without disabling the scope on any other pages.

awcodes•2mo ago

Sounds like you have two different things competing with each other. Yea, in the resource just disable the scope with a check against the auth user.

BatmanOP•2mo ago

Is there a way to add checking for the specific resource pages in the getEloquentQuery() to disable scope only when loading those two pages That also creates a mess on the table loading soft deletes in other tabs it shouldn't

awcodes•2mo ago

Not saying you won’t need additional checks. But in the resource you can conditionally apply the removal of global scopes based on the user. But you can’t hit an edit page for a soft deleted record without removing the scope. That’s just how laravel scopes work. Nothing to do with filament.

BatmanOP•2mo ago

"But you can’t hit an edit page for a soft deleted record without removing the scope." Exactly what I want to do: modify query on Edit or View load. This is filament not allowing me to edit the query that loads a user.

awcodes•2mo ago

public static function getEloquentQuery(): Builder
    {
        if(auth()->isSA) {
        return parent::getEloquentQuery()
            ->withoutGlobalScopes([
                SoftDeletingScope::class,
            ]);
         }
    }

public static function getEloquentQuery(): Builder
    {
        if(auth()->isSA) {
        return parent::getEloquentQuery()
            ->withoutGlobalScopes([
                SoftDeletingScope::class,
            ]);
         }
    }

BatmanOP•2mo ago

public static function getEloquentQuery(): Builder
    {
        if (Auth::user()->hasRole(Roles::SUPER_ADMIN)) {
            // Check for resouce pages view or edit and if true then:
            return parent::getEloquentQuery()
                ->withoutGlobalScopes([
                    SoftDeletingScope::class,
                ]);
        }
    }

public static function getEloquentQuery(): Builder
    {
        if (Auth::user()->hasRole(Roles::SUPER_ADMIN)) {
            // Check for resouce pages view or edit and if true then:
            return parent::getEloquentQuery()
                ->withoutGlobalScopes([
                    SoftDeletingScope::class,
                ]);
        }
    }

awcodes•2mo ago

I would expect that to work.

BatmanOP•2mo ago

As I asked earlier. Is there a way to add checking for the specific resource pages in the getEloquentQuery() to disable scope only when loading those two pages

awcodes•2mo ago

But you might need to disable the scope on the EditRecord specifically too. Yea, just have to do it on the EditResource etc and not on the Resource class itself.

BatmanOP•2mo ago

Yes, Pages\EditUser and Pages\ViewUser only That was my original question. "What is the best way to modify the query when loading an edit or view page?"

awcodes•2mo ago

The code I shared works for me on edit pages. I’m able to edit soft deleted records

BatmanOP•2mo ago

It does work for edit pages. But then I need to go to all the other filters and queries that are not supposed to load that information and change those. Which makes a spagetti mess everywhere when I only want to disable the scope for those two pages and only if the user is SA.

awcodes•2mo ago

That one method handles it all. No soft deleted records show up in my table unless I filter for trashed records and the edit/view pages all work. Could be a bug in the tab’s implementation though. Hard to say though since I’m going through filters and not tabs. Do you have a repo you can share. Might help to see the whole implementation.

BatmanOP•2mo ago

Using the getEloquentQuery() method disables the scopes for the tabs also, so yes I am getting soft deleted users listed with everything else that should be scoped. I can make it public.

awcodes•2mo ago

Getting late here but if you want to open it or add me to it I’d be happy to take a look tomorrow. Just make sure you have the appropriate seeders, etc in place so I can clone and go.

BatmanOP•2mo ago

Same here. I'll make sure the seeders are up to date tonight or in the AM.

awcodes•2mo ago

No worries. Just trying to help.

BatmanOP•2mo ago

I much appreciate it! @awcodes added you to the repository.

awcodes•2mo ago

I’ll pull it down as soon as I can and get back to you.

Solution

Batman•2mo ago

@awcodes Believe I got it figured out.

public static function getEloquentQuery(): Builder  
{  
    if (Auth::user()->hasRole(Roles::SUPER_ADMIN)) {  
        // Check if the resource page is view or edit and if true then disable global scope:  
        if (  
            Route::currentRouteName() === Pages\EditUser::getRouteName('admin')  
            || Route::currentRouteName() === Pages\ViewUser::getRouteName('admin')  
        ) {  
            return parent::getEloquentQuery()  
                ->withoutGlobalScopes([  
                    SoftDeletingScope::class,  
                ]);  
        }  
    }  
  
    return parent::getEloquentQuery();  
}

public static function getEloquentQuery(): Builder  
{  
    if (Auth::user()->hasRole(Roles::SUPER_ADMIN)) {  
        // Check if the resource page is view or edit and if true then disable global scope:  
        if (  
            Route::currentRouteName() === Pages\EditUser::getRouteName('admin')  
            || Route::currentRouteName() === Pages\ViewUser::getRouteName('admin')  
        ) {  
            return parent::getEloquentQuery()  
                ->withoutGlobalScopes([  
                    SoftDeletingScope::class,  
                ]);  
        }  
    }  
  
    return parent::getEloquentQuery();  
}

Found in this discussion: https://github.com/filamentphp/filament/discussions/10042

GitHub

Easy way to check the current page inside resource class · filament...

awcodes•2mo ago

Great. If it works then carry on. 😀

BatmanOP•2mo ago

@awcodes Thanks for the time and help!

awcodes•2mo ago

No worries. Glad you got it sorted.

Gaming

Programming

Modify query when loading edit/view form

Did you find this page helpful?