Filament•2y ago

Is it possible to use Filament fields inside custom "Livewire" Action classes?

So, if you are aware of the Action classes that are implemented in a plugin similar to Jetstream, you might understand what I am speaking about. If not, I will explain. In the hierarchy of a Custom Action class, first there is a registered class/callback such as an Interface using the singleton() design pattern. This Interface contains methods needed to implement the Action class. First, there is a Livewire Component that contains a method using Interface Injection variant of the Dependency Injection design pattern like this. The Livewire Component:

namespace Wallo\FilamentCompanies\Http\Livewire;

use Livewire\Component;
use Wallo\FilamentCompanies\Contracts\UpdatesCompanyNames;

class UpdateCompanyNameForm extends Component
{
    /**
     * Update the company's name.
     */
    public function updateCompanyName(UpdatesCompanyNames $updater): void
    {
        $updater->update($this->user, $this->company, $this->state);
    }
}

namespace Wallo\FilamentCompanies\Http\Livewire;

use Livewire\Component;
use Wallo\FilamentCompanies\Contracts\UpdatesCompanyNames;

class UpdateCompanyNameForm extends Component
{
    /**
     * Update the company's name.
     */
    public function updateCompanyName(UpdatesCompanyNames $updater): void
    {
        $updater->update($this->user, $this->company, $this->state);
    }
}

This is then extended by the Action class like this:

namespace App\Actions\FilamentCompanies;

use App\Models\Company;
use App\Models\User;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Support\Facades\Gate;
use Illuminate\Support\Facades\Validator;
use Wallo\FilamentCompanies\Contracts\UpdatesCompanyNames;

class UpdateCompanyName implements UpdatesCompanyNames
{
    public function update(User $user, Company $company, array $input): void
    {
        Gate::forUser($user)->authorize('update', $company);

        Validator::make($input, [
            'name' => ['required', 'string', 'max:255'],
        ])->validateWithBag('updateCompanyName');

        $company->forceFill([
            'name' => $input['name'],
        ])->save();
    }
}

namespace App\Actions\FilamentCompanies;

use App\Models\Company;
use App\Models\User;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Support\Facades\Gate;
use Illuminate\Support\Facades\Validator;
use Wallo\FilamentCompanies\Contracts\UpdatesCompanyNames;

class UpdateCompanyName implements UpdatesCompanyNames
{
    public function update(User $user, Company $company, array $input): void
    {
        Gate::forUser($user)->authorize('update', $company);

        Validator::make($input, [
            'name' => ['required', 'string', 'max:255'],
        ])->validateWithBag('updateCompanyName');

        $company->forceFill([
            'name' => $input['name'],
        ])->save();
    }
}

My question: Is it possible to use Filament fields in the Action class instead of what is used here so that Users of my package can change the fields without touching the blade view? If so, how could this be done?

10 Replies

wyChoong•2y ago

tbh I feel you are overcomplicating stuffs. Think Filament's Resource class in your action class, implement a getFormSchema method that return an array of fields, then in your component Action::getFormSchema to retrieve them however sooner or later you might find you basically renaming Resource -> Action and doing the same thing by offering the customizing methods. Probably just publish as vendor load that if the file exist in userland, eg: App\Companies namespace

Andrew WalloOP•2y ago

I wasn’t over complicating anything, I was just explaining exactly the layout of my package. I am a little confused on what you are saying though. Could you perhaps give me any examples that could work that won’t interfere with the entire flow of my data? If possible

Dan Harrin•2y ago

the way i write action classes is that they dont handle validation or authorization they just "do" something because its often contextual what validation applies so i define my filament form like normal in livewire, call getState() and then pass that data into the action pre-validated

Andrew WalloOP•2y ago

So are you saying I probably can’t pass the getFormSchema() into the Action class? I would also have to somehow mount the form data and pass it as well. The “update()” method in the Action class is essentially just an extension of the “updateCompanyName()” method in the Livewire component. But if not, could creating a dynamic component myself be a solution here?

wyChoong•2y ago

Basically what Dan saying is

namespace Wallo\FilamentCompanies\Http\Livewire;

use Livewire\Component;
use Wallo\FilamentCompanies\Contracts\UpdatesCompanyNames;

class UpdateCompanyNameForm extends Component
{
    /**
     * Update the company's name.
     */
    public function updateCompanyName(UpdatesCompanyNames $updater): void
    {

        $formValues = $this->form->getState(); // let filament form handle the validation
        $updater->update($this->user, $this->company, $formValues); // the action class should just do something but not validating the form values
    }
}

namespace Wallo\FilamentCompanies\Http\Livewire;

use Livewire\Component;
use Wallo\FilamentCompanies\Contracts\UpdatesCompanyNames;

class UpdateCompanyNameForm extends Component
{
    /**
     * Update the company's name.
     */
    public function updateCompanyName(UpdatesCompanyNames $updater): void
    {

        $formValues = $this->form->getState(); // let filament form handle the validation
        $updater->update($this->user, $this->company, $formValues); // the action class should just do something but not validating the form values
    }
}

Think about the filament login page component. You have a default component to use out of the box, but for customization the user can extend it and register it

Dan Harrin•2y ago

yeah you could put the form schema in a method on the action class if you wanted

wyChoong•2y ago

Usually Action/Service class gives a context of do something

Dan Harrin•2y ago

but it would still be consumed and validated by the lw component

wyChoong•2y ago

If you want to organize it, can have a Companies\Forms namespace/directory where you define class to have a method to return form schema like the resource class

Andrew WalloOP•2y ago

That is essentially what my Action classes are for… I’m not going to change the entire directory But sounds good I’ll see if I can extend the formSchema to the action classes

Gaming

Programming

Is it possible to use Filament fields inside custom "Livewire" Action classes?