# Installation

# Install the package

All you need to do to get started is add Laravel Action to your composer dependencies.

composer require lorisleiva/laravel-actions

You can then add the AsAction trait to any of your classes to make it an action.

use Lorisleiva\Actions\Concerns\AsAction;

class UpdateUserPassword
    use AsAction;

    public function handle(User $user, string $newPassword)
        // ...

# Install ide helper for autocomplete (optional)

If you use a PHP version of ^8.0 you may want to install an additional package similar to laravel-ide-helper (opens new window) which enables your IDE to provide accurate autocompletion for your actions.

All you need to do is add wulfheart/laravel-actions-ide-helper to your dependencies.

composer require --dev wulfheart/laravel-actions-ide-helper

You can now generate the docs for yourself by running the command below. This will generate the file _ide_helper_actions.php which is expected to be additionally parsed by your IDE for autocomplete.

php artisan ide-helper:actions

# Publish the action stub (optional)

You may publish the stub used by the make:action command if you want to modify it.

php artisan vendor:publish --tag=stubs --provider="Lorisleiva\Actions\ActionServiceProvider"
Last Updated: 1/26/2022, 11:46:22 AM