[Workflow] Add types to private properties

Signed-off-by: Alexander M. Turek <[email protected]>

Author: derrabus

Definition.php

@@ -22,10 +22,10 @@
  */
 final class Definition
 {
-    private $places = [];
-    private $transitions = [];
-    private $initialPlaces = [];
-    private $metadataStore;
+    private array $places = [];
+    private array $transitions = [];
+    private array $initialPlaces = [];
+    private MetadataStoreInterface $metadataStore;
 
     /**
      * @param string[]             $places

DefinitionBuilder.php

@@ -22,10 +22,10 @@
  */
 class DefinitionBuilder
 {
-    private $places = [];
-    private $transitions = [];
-    private $initialPlaces;
-    private $metadataStore;
+    private array $places = [];
+    private array $transitions = [];
+    private string|array|null $initialPlaces = null;
+    private ?MetadataStoreInterface $metadataStore = null;
 
     /**
      * @param string[]     $places

Dumper/MermaidDumper.php

@@ -39,23 +39,14 @@ class MermaidDumper implements DumperInterface
         self::TRANSITION_TYPE_WORKFLOW,
     ];
 
-    /**
-     * @var string
-     */
-    private $direction;
-
-    /**
-     * @var string
-     */
-    private $transitionType;
+    private string $direction;
+    private string $transitionType;
 
     /**
      * Just tracking the transition id is in some cases inaccurate to
      * get the link's number for styling purposes.
-     *
-     * @var int
      */
-    private $linkCount;
+    private int $linkCount = 0;
 
     public function __construct(string $transitionType, string $direction = self::DIRECTION_LEFT_TO_RIGHT)
     {

Dumper/PlantUmlDumper.php

@@ -52,9 +52,9 @@ class PlantUmlDumper implements DumperInterface
         ],
     ];
 
-    private $transitionType = self::STATEMACHINE_TRANSITION;
+    private string $transitionType = self::STATEMACHINE_TRANSITION;
 
-    public function __construct(string $transitionType = null)
+    public function __construct(string $transitionType)
     {
         if (!\in_array($transitionType, self::TRANSITION_TYPES, true)) {
             throw new InvalidArgumentException("Transition type '$transitionType' does not exist.");

Event/Event.php

@@ -24,10 +24,10 @@
 class Event extends BaseEvent
 {
     protected $context;
-    private $subject;
-    private $marking;
-    private $transition;
-    private $workflow;
+    private object $subject;
+    private Marking $marking;
+    private ?Transition $transition;
+    private ?WorkflowInterface $workflow;
 
     public function __construct(object $subject, Marking $marking, Transition $transition = null, WorkflowInterface $workflow = null, array $context = [])
     {

Event/GuardEvent.php

@@ -23,7 +23,7 @@
  */
 final class GuardEvent extends Event
 {
-    private $transitionBlockerList;
+    private TransitionBlockerList $transitionBlockerList;
 
     /**
      * {@inheritdoc}

EventListener/AuditTrailListener.php

@@ -20,7 +20,7 @@
  */
 class AuditTrailListener implements EventSubscriberInterface
 {
-    private $logger;
+    private LoggerInterface $logger;
 
     public function __construct(LoggerInterface $logger)
     {

EventListener/GuardExpression.php

@@ -15,8 +15,8 @@
 
 class GuardExpression
 {
-    private $transition;
-    private $expression;
+    private Transition $transition;
+    private string $expression;
 
     public function __construct(Transition $transition, string $expression)
     {

EventListener/GuardListener.php

@@ -24,13 +24,13 @@
  */
 class GuardListener
 {
-    private $configuration;
-    private $expressionLanguage;
-    private $tokenStorage;
-    private $authorizationChecker;
-    private $trustResolver;
-    private $roleHierarchy;
-    private $validator;
+    private array $configuration;
+    private ExpressionLanguage $expressionLanguage;
+    private TokenStorageInterface $tokenStorage;
+    private AuthorizationCheckerInterface $authorizationChecker;
+    private AuthenticationTrustResolverInterface $trustResolver;
+    private ?RoleHierarchyInterface $roleHierarchy;
+    private ?ValidatorInterface $validator;
 
     public function __construct(array $configuration, ExpressionLanguage $expressionLanguage, TokenStorageInterface $tokenStorage, AuthorizationCheckerInterface $authorizationChecker, AuthenticationTrustResolverInterface $trustResolver, RoleHierarchyInterface $roleHierarchy = null, ValidatorInterface $validator = null)
     {

Exception/NotEnabledTransitionException.php

@@ -21,7 +21,7 @@
  */
 class NotEnabledTransitionException extends TransitionException
 {
-    private $transitionBlockerList;
+    private TransitionBlockerList $transitionBlockerList;
 
     public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow, TransitionBlockerList $transitionBlockerList, array $context = [])
     {

Exception/TransitionException.php

@@ -19,10 +19,10 @@
  */
 class TransitionException extends LogicException
 {
-    private $subject;
-    private $transitionName;
-    private $workflow;
-    private $context;
+    private object $subject;
+    private string $transitionName;
+    private WorkflowInterface $workflow;
+    private array $context;
 
     public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow, string $message, array $context = [])
     {

Marking.php

@@ -18,8 +18,8 @@
  */
 class Marking
 {
-    private $places = [];
-    private $context = null;
+    private array $places = [];
+    private ?array $context = null;
 
     /**
      * @param int[] $representation Keys are the place name and values should be 1

MarkingStore/MethodMarkingStore.php

@@ -29,8 +29,8 @@
  */
 final class MethodMarkingStore implements MarkingStoreInterface
 {
-    private $singleState;
-    private $property;
+    private bool $singleState;
+    private string $property;
 
     /**
      * @param string $property Used to determine methods to call

Metadata/InMemoryMetadataStore.php

@@ -20,9 +20,9 @@ final class InMemoryMetadataStore implements MetadataStoreInterface
 {
     use GetMetadataTrait;
 
-    private $workflowMetadata;
-    private $placesMetadata;
-    private $transitionsMetadata;
+    private array $workflowMetadata;
+    private array $placesMetadata;
+    private \SplObjectStorage $transitionsMetadata;
 
     public function __construct(array $workflowMetadata = [], array $placesMetadata = [], \SplObjectStorage $transitionsMetadata = null)
     {

Registry.php

@@ -20,7 +20,7 @@
  */
 class Registry
 {
-    private $workflows = [];
+    private array $workflows = [];
 
     public function addWorkflow(WorkflowInterface $workflow, WorkflowSupportStrategyInterface $supportStrategy)
     {

SupportStrategy/InstanceOfSupportStrategy.php

@@ -19,7 +19,7 @@
  */
 final class InstanceOfSupportStrategy implements WorkflowSupportStrategyInterface
 {
-    private $className;
+    private string $className;
 
     public function __construct(string $className)
     {

Transition.php

@@ -17,9 +17,9 @@
  */
 class Transition
 {
-    private $name;
-    private $froms;
-    private $tos;
+    private string $name;
+    private array $froms;
+    private array $tos;
 
     /**
      * @param string|string[] $froms

TransitionBlocker.php

@@ -20,9 +20,9 @@ final class TransitionBlocker
     public const BLOCKED_BY_EXPRESSION_GUARD_LISTENER = '326a1e9c-0c12-11e8-ba89-0ed5f89f718b';
     public const UNKNOWN = 'e8b5bbb9-5913-4b98-bfa6-65dbd228a82a';
 
-    private $message;
-    private $code;
-    private $parameters;
+    private string $message;
+    private string $code;
+    private array $parameters;
 
     /**
      * @param string $code       Code is a machine-readable string, usually an UUID

TransitionBlockerList.php

@@ -18,7 +18,7 @@
  */
 final class TransitionBlockerList implements \IteratorAggregate, \Countable
 {
-    private $blockers;
+    private array $blockers;
 
     /**
      * @param TransitionBlocker[] $blockers

Validator/WorkflowValidator.php

@@ -20,7 +20,7 @@
  */
 class WorkflowValidator implements DefinitionValidatorInterface
 {
-    private $singlePlace;
+    private bool $singlePlace;
 
     public function __construct(bool $singlePlace = false)
     {

Workflow.php

@@ -52,10 +52,10 @@ class Workflow implements WorkflowInterface
         WorkflowEvents::ANNOUNCE => self::DISABLE_ANNOUNCE_EVENT,
     ];
 
-    private $definition;
-    private $markingStore;
-    private $dispatcher;
-    private $name;
+    private Definition $definition;
+    private MarkingStoreInterface $markingStore;
+    private ?EventDispatcherInterface $dispatcher;
+    private string $name;
 
     /**
      * When `null` fire all events (the default behaviour).
@@ -65,7 +65,7 @@ class Workflow implements WorkflowInterface
      *
      * @var array|string[]|null
      */
-    private $eventsToDispatch = null;
+    private ?array $eventsToDispatch = null;
 
     public function __construct(Definition $definition, MarkingStoreInterface $markingStore = null, EventDispatcherInterface $dispatcher = null, string $name = 'unnamed', array $eventsToDispatch = null)
     {