cleaniquecoders/laravel-action

Simple Actionable for Laravel

2.1.2 2024-11-01 02:44 UTC

Requires

• php: ^8.2
• cleaniquecoders/laravel-contract: ^1.0
• cleaniquecoders/traitify: ^1.0
• illuminate/contracts: ^10.0||^11.0
• lorisleiva/laravel-actions: ^2.8
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.5
• pestphp/pest: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.5 | ^10.0

MIT

• Nasrul Hazim Bin Mohamad

• laravel
• cleaniquecoders
• laravel-action

README

This package, Simple Actionable for Laravel, provides a structured way to manage action classes in your Laravel applications, making it easier to encapsulate business logic, transformations, and validations within reusable classes. The package utilizes lorisleiva/laravel-actions to offer extended functionality, enabling actions to be executed in multiple contexts (e.g., jobs, controllers, event listeners) and simplifying your codebase.

Installation

You can install the package via composer:

composer require cleaniquecoders/laravel-action

Features

This package builds on top of lorisleiva/laravel-actions, allowing you to:

• Create versatile action classes that can be executed as invokable objects, controllers, or dispatched as jobs.
• Use property setters to configure actions dynamically.
• Apply transformations like hashing or encryption to specific fields.
• Manage updateOrCreate behavior with constraints on unique fields.

Usage

You can create an action using the Artisan command:

php artisan make:action User\\CreateOrUpdateUser --model=User

This will create an action in app\Actions\User:

<?php

namespace App\Actions\User;

use App\Models\User;
use CleaniqueCoders\LaravelAction\ResourceAction;

class CreateOrUpdateUser extends ResourceAction
{
    public string $model = User::class;

    public function rules(): array
    {
        return [
            'name' => 'required|string|max:255',
            'email' => 'required|string|email|unique:users,email',
            'password' => 'required|string|min:8',
        ];
    }
}

New Features and Example Usage

1. Flexible Property Setter

You can set properties, such as hashFields, encryptFields, and constrainedBy, dynamically using the setProperty method:

$action = new CreateOrUpdateUser(['name' => 'John Doe', 'email' => '[e-mail]', 'password' => 'secretpassword']);
$action->setProperty('hashFields', ['password']); // Hash the password
$action->setProperty('encryptFields', ['ssn']); // Encrypt SSN
$action->setProperty('constrainedBy', ['email' => '[e-mail]']); // Use email as a unique constraint

This flexible property setting reduces boilerplate and simplifies action configuration.

2. Field Transformation with Hashing and Encryption

The ResourceAction class supports field-level transformations. For example, you can hash a password field and encrypt an ssn field:

$inputs = [
    'name' => 'Jane Doe',
    'email' => '[e-mail]',
    'password' => 'securepassword',
    'ssn' => '123-45-6789',
];

$action = new CreateOrUpdateUser($inputs);
$action->setProperty('hashFields', ['password']);
$action->setProperty('encryptFields', ['ssn']);
$record = $action->handle();

After execution:

• The password field will be hashed for security.
• The ssn field will be encrypted, ensuring secure storage.

3. Constraint-Based updateOrCreate

Specify constraints to perform updateOrCreate actions based on unique fields or identifiers. Here’s an example of updating an existing user by id:

// Assume there's an existing user with this email
$existingUser = User::create([
    'name' => 'Old Name',
    'email' => '[e-mail]',
    'password' => Hash::make('oldpassword'),
]);

// Define the inputs to update the existing user
$inputs = [
    'name' => 'John Doe Updated',
    'email' => '[e-mail]', // Same email
    'password' => 'newpassword',
];

$action = new CreateOrUpdateUser($inputs);
$action->setProperty('constrainedBy', ['id' => $existingUser->id]); // Update by user ID

$record = $action->handle();

// The existing user record with the specified ID will be updated.

This allows precise control over updateOrCreate behavior based on custom constraints.

Using lorisleiva/laravel-actions for Multi-Context Execution

With lorisleiva/laravel-actions, actions created with this package can be used in multiple contexts. You can run the action as:

• An Invokable Object:

  $user = (new CreateOrUpdateUser(['name' => 'Jane', 'email' => '[e-mail]']))->handle();

• A Controller:

  Route::post('users', CreateOrUpdateUser::class);

• A Job:

  CreateOrUpdateUser::dispatch(['name' => 'Jane', 'email' => '[e-mail]']);

• An Event Listener:

  Event::listen(UserRegistered::class, CreateOrUpdateUser::class);

Testing

Run the tests with:

composer test

Changelog

Please see CHANGELOG for more information on recent changes.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Nasrul Hazim Bin Mohamad
• All Contributors

License

The MIT License (MIT). Please see License File for more information.