Feature: Added ...transitionArgs to default transition constructor call to allow arguments use for custom default transition

[IlliaVeremiev]

Foreword

Custom Transition can be initialized with arguments from transitionTo parameters.
Custom default Transition can be registeren in the configuration for transitions between all states, but can not be initialized with arguments as non default transition.

Requirement

When calling transitionTo method I would like to pass additional arguments that can be used in StateChanged event listener.

Suggestion

Add ...transitionArgs to $defaultTransition(...) constructor call.

Use case

We need to handle status change in event listener, but depending on where transitionTo called from, in some cases we should notify user about event, but in some cases not. We can create custom DefaultTransition with additional silent parameter.

// CustomDefaultTransitionWithAttributes.php

class CustomDefaultTransitionWithAttributes extends DefaultTransition
{
    public function __construct($model, string $field, State $newState, public bool $silent = false)
    {
        parent::__construct($model, $field, $newState);
    }
}

// model-states.php

return [
    'default_transition' => CustomDefaultTransitionWithAttributes::class
];

// OrderStateChangedListener.php

class OrderStateChangedListener
{
    public function handle(StatusChange $event): void
    {
        // do some logic
        if (! $event->transition->silent) {
            // send notification
        }
    }
}

// Business logic layer

$order->status->transitionTo($status->value); // Sends notification

$order->status->transitionTo($status->value, false);  // Sends notification

$order->status->transitionTo($status->value, true); // Doesn't send notification, but still performs logic

[Briareos17]

@freekmurze This realy needed

[freekmurze]

Could you add an example of this new functionality to the docs?

[IlliaVeremiev]

Hi @freekmurze,
Updated docs with short description and usage example

[freekmurze]

Could you rebase against to current main to see if the tests run properly?

[IlliaVeremiev]

@freekmurze done

[freekmurze]

Thanks!