phpstan

composer.json

@@ -57,7 +57,7 @@
             "@composer run build",
             "@php vendor/bin/testbench serve"
         ],
-        "analyse": "vendor/bin/phpstan analyse",
+        "analyse": "php -d memory_limit=2G vendor/bin/phpstan analyse --memory-limit=2G",
         "test": "vendor/bin/pest",
         "test-coverage": "vendor/bin/pest --coverage",
         "format": "vendor/bin/pint"

src/Abstracts/AbstractTransitionSuccessJob.php

@@ -19,6 +19,7 @@ public function __construct(
         public StateableModelContract&Model $model,
         public string $from,
         public string $to,
+        /** @var array<string, mixed> */
         public array $parameters = []) {}
 
     /**

src/ArFlowService.php

@@ -2,14 +2,14 @@
 
 namespace AuroraWebSoftware\ArFlow;
 
-use AuroraWebSoftware\ArFlow\Exceptions\StateNotFoundException;
 use AuroraWebSoftware\ArFlow\Exceptions\WorkflowNotFoundException;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Config;
 
 class ArFlowService
 {
+    /** @var array<string, array{states: array<string>, initial_state: string, transitions?: array<string, array{from: string|array<string>, to: string|array<string>, guards?: array<array{0: class-string, 1?: array<string, mixed>}>, actions?: array<array{0: class-string, 1?: array<string, mixed>}>, success_metadata?: array<string, mixed>, success_jobs?: array<array{0: class-string, 1?: array<string, mixed>}>}>}> */
     private array $workflows;
 
     public function __construct()
@@ -21,18 +21,20 @@ public function __construct()
      * @return array<string>
      *
      * @throws WorkflowNotFoundException
-     * @throws StateNotFoundException
      */
     public function getStates(string $workflow): array
     {
         foreach ($this->workflows as $workflowKey => $workflowValues) {
             if ($workflowKey == $workflow) {
-                return $workflowValues['states'] ?? throw new StateNotFoundException;
+                return $workflowValues['states'];
             }
         }
         throw new WorkflowNotFoundException;
     }
 
+    /**
+     * @return array<class-string>
+     */
     public function getSupportedModelTypes(string $workflow): array
     {
         return [];

src/Collections/TransitionGuardResultCollection.php

@@ -6,7 +6,7 @@
 use Illuminate\Support\Collection;
 
 /**
- * @extends Collection<string, TransitionGuardResultCollection<TransitionGuardResultDTO>>
+ * @extends Collection<string, Collection<int, TransitionGuardResultDTO>>
  */
 class TransitionGuardResultCollection extends Collection
 {

src/Contacts/StateableModelContract.php

@@ -69,34 +69,42 @@ public function currentState(): string;
     public function currentStateMetadata(): array;
 
     /**
+     * @param  array<class-string>|null  $withoutGuards
      * @return TransitionGuardResultCollection<string, Collection<int, TransitionGuardResultDTO>>
      *
      * @throws WorkflowNotFoundException
      */
     public function transitionGuardResults(string $toState, ?array $withoutGuards = null): TransitionGuardResultCollection;
 
+    /**
+     * @param  array<class-string>|null  $withoutGuards
+     */
     public function canTransitionTo(string $toState, ?array $withoutGuards = null): bool;
 
     /**
+     * @param  array<class-string>|null  $withoutGuards
      * @return array<string>|null
      */
     public function definedTransitionKeys(?array $withoutGuards = null): ?array;
 
     /**
      * @param  array<class-string>|null  $withoutGuards
+     * @return array<string>|null
      *
      * @throws WorkflowNotFoundException
      * @throws Throwable
      */
     public function allowedTransitionKeys(?array $withoutGuards = null): ?array;
 
     /**
+     * @param  array<class-string>|null  $withoutGuards
      * @return array<string>|null
      */
     public function definedTransitionStates(?array $withoutGuards = null): ?array;
 
     /**
      * @param  array<class-string>|null  $withoutGuards
+     * @return array<string>|null
      *
      * @throws WorkflowNotFoundException
      * @throws Throwable
@@ -108,6 +116,7 @@ public function lastUpdatedTime(): ?DateTime;
     /**
      * @param  class-string|null  $actorModelType
      * @param  array<class-string>|null  $withoutGuards
+     * @param  array<string, mixed>|null  $metadata
      *
      * @throws StateNotFoundException
      * @throws TransitionActionException

src/Contacts/TransitionActionContract.php

@@ -8,6 +8,9 @@
 
 interface TransitionActionContract
 {
+    /**
+     * @param  array<string, mixed>  $parameters
+     */
     public function boot(StateableModelContract&Model $model, string $from, string $to, array $parameters = []): void;
 
     /**

src/Contacts/TransitionGuardContract.php

@@ -9,6 +9,9 @@
 
 interface TransitionGuardContract
 {
+    /**
+     * @param  array<string, mixed>  $parameters
+     */
     public function boot(StateableModelContract&Model $model, string $from, string $to, array $parameters): void;
 
     /**

src/StateTransition.php

@@ -22,6 +22,7 @@ class StateTransition extends Model
 
     public string $comment;
 
+    /** @var array<string, mixed> */
     public array $metadata;
 
     public int $model_id;

src/Traits/HasState.php

@@ -24,6 +24,9 @@
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Config;
 
+/**
+ * @phpstan-ignore-next-line
+ */
 trait HasState
 {
     public function getId(): int|string

src/TransitionActions/LogHistoryTransitionAction.php

@@ -9,6 +9,7 @@
 
 class LogHistoryTransitionAction implements TransitionActionContract
 {
+    /** @var array<string, mixed> */
     private array $parameters;
 
     private StateableModelContract&Model $model;
@@ -17,6 +18,9 @@ class LogHistoryTransitionAction implements TransitionActionContract
 
     private string $to;
 
+    /**
+     * @param  array<string, mixed>  $parameters
+     */
     public function boot(StateableModelContract&Model $model, string $from, string $to, array $parameters = []): void
     {
         $this->model = $model;

tests/TransitionActions/TestSuccessTransitionAction.php

@@ -8,8 +8,12 @@
 
 class TestSuccessTransitionAction implements TransitionActionContract
 {
+    /** @var array<string, mixed> */
     public array $parameters;
 
+    /**
+     * @param  array<string, mixed>  $parameters
+     */
     public function boot(StateableModelContract&Model $model, string $from, string $to, array $parameters = []): void
     {
         $this->parameters = $parameters;