[Workflow] Added parameter typhint where possible

lyrixx · lyrixx · commit 37fd64515d76 · 2019-06-27T16:36:42.000+02:00
diff --git a/src/Symfony/Component/Workflow/DefinitionBuilder.php b/src/Symfony/Component/Workflow/DefinitionBuilder.php
@@ -61,8 +61,6 @@ public function clear()
     }
 
     /**
-     * @param string $place
-     *
      * @return $this
      */
     public function setInitialPlace($place)
@@ -73,11 +71,9 @@ public function setInitialPlace($place)
     }
 
     /**
-     * @param string $place
-     *
      * @return $this
      */
-    public function addPlace($place)
+    public function addPlace(string $place)
     {
         if (!$this->places) {
             $this->initialPlace = $place;
diff --git a/src/Symfony/Component/Workflow/Dumper/DumperInterface.php b/src/Symfony/Component/Workflow/Dumper/DumperInterface.php
@@ -25,10 +25,6 @@ interface DumperInterface
     /**
      * Dumps a workflow definition.
      *
-     * @param Definition   $definition A Definition instance
-     * @param Marking|null $marking    A Marking instance
-     * @param array        $options    An array of options
-     *
      * @return string The representation of the workflow
      */
     public function dump(Definition $definition, Marking $marking = null, array $options = []);
diff --git a/src/Symfony/Component/Workflow/Dumper/GraphvizDumper.php b/src/Symfony/Component/Workflow/Dumper/GraphvizDumper.php
@@ -236,15 +236,15 @@ protected function endDot()
     /**
      * @internal
      */
-    protected function dotize($id)
+    protected function dotize(string $id)
     {
         return hash('sha1', $id);
     }
 
     /**
      * @internal
      */
-    protected function escape($value): string
+    protected function escape(string $value): string
     {
         return \is_bool($value) ? ($value ? '1' : '0') : addslashes($value);
     }
diff --git a/src/Symfony/Component/Workflow/Event/Event.php b/src/Symfony/Component/Workflow/Event/Event.php
@@ -27,10 +27,7 @@ class Event extends BaseEvent
     private $transition;
     private $workflow;
 
-    /**
-     * @param object $subject
-     */
-    public function __construct($subject, Marking $marking, Transition $transition = null, WorkflowInterface $workflow = null)
+    public function __construct(object $subject, Marking $marking, Transition $transition = null, WorkflowInterface $workflow = null)
     {
         $this->subject = $subject;
         $this->marking = $marking;
@@ -63,7 +60,7 @@ public function getWorkflowName()
         return $this->workflow->getName();
     }
 
-    public function getMetadata(string $key, $subject)
+    public function getMetadata(string $key, object $subject)
     {
         return $this->workflow->getMetadataStore()->getMetadata($key, $subject);
     }
diff --git a/src/Symfony/Component/Workflow/Event/GuardEvent.php b/src/Symfony/Component/Workflow/Event/GuardEvent.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Workflow\Transition;
 use Symfony\Component\Workflow\TransitionBlocker;
 use Symfony\Component\Workflow\TransitionBlockerList;
+use Symfony\Component\Workflow\WorkflowInterface;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
@@ -27,9 +28,9 @@ class GuardEvent extends Event
     /**
      * {@inheritdoc}
      */
-    public function __construct($subject, Marking $marking, Transition $transition, $workflowName = null)
+    public function __construct(object $subject, Marking $marking, Transition $transition, WorkflowInterface $workflow = null)
     {
-        parent::__construct($subject, $marking, $transition, $workflowName);
+        parent::__construct($subject, $marking, $transition, $workflow);
 
         $this->transitionBlockerList = new TransitionBlockerList();
     }
diff --git a/src/Symfony/Component/Workflow/EventListener/GuardExpression.php b/src/Symfony/Component/Workflow/EventListener/GuardExpression.php
@@ -16,13 +16,9 @@
 class GuardExpression
 {
     private $transition;
-
     private $expression;
 
-    /**
-     * @param string $expression
-     */
-    public function __construct(Transition $transition, $expression)
+    public function __construct(Transition $transition, string $expression)
     {
         $this->transition = $transition;
         $this->expression = $expression;
diff --git a/src/Symfony/Component/Workflow/EventListener/GuardListener.php b/src/Symfony/Component/Workflow/EventListener/GuardListener.php
@@ -44,7 +44,7 @@ public function __construct(array $configuration, ExpressionLanguage $expression
         $this->validator = $validator;
     }
 
-    public function onTransition(GuardEvent $event, $eventName)
+    public function onTransition(GuardEvent $event, string $eventName)
     {
         if (!isset($this->configuration[$eventName])) {
             return;
diff --git a/src/Symfony/Component/Workflow/Exception/NotEnabledTransitionException.php b/src/Symfony/Component/Workflow/Exception/NotEnabledTransitionException.php
@@ -23,7 +23,7 @@ class NotEnabledTransitionException extends TransitionException
 {
     private $transitionBlockerList;
 
-    public function __construct($subject, string $transitionName, WorkflowInterface $workflow, TransitionBlockerList $transitionBlockerList)
+    public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow, TransitionBlockerList $transitionBlockerList)
     {
         parent::__construct($subject, $transitionName, $workflow, sprintf('Transition "%s" is not enabled for workflow "%s".', $transitionName, $workflow->getName()));
 
diff --git a/src/Symfony/Component/Workflow/Exception/TransitionException.php b/src/Symfony/Component/Workflow/Exception/TransitionException.php
@@ -23,7 +23,7 @@ class TransitionException extends LogicException
     private $transitionName;
     private $workflow;
 
-    public function __construct($subject, string $transitionName, WorkflowInterface $workflow, string $message)
+    public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow, string $message)
     {
         parent::__construct($message);
 
diff --git a/src/Symfony/Component/Workflow/Exception/UndefinedTransitionException.php b/src/Symfony/Component/Workflow/Exception/UndefinedTransitionException.php
@@ -20,7 +20,7 @@
  */
 class UndefinedTransitionException extends TransitionException
 {
-    public function __construct($subject, string $transitionName, WorkflowInterface $workflow)
+    public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow)
     {
         parent::__construct($subject, $transitionName, $workflow, sprintf('Transition "%s" is not defined for workflow "%s".', $transitionName, $workflow->getName()));
     }
diff --git a/src/Symfony/Component/Workflow/Marking.php b/src/Symfony/Component/Workflow/Marking.php
@@ -30,17 +30,17 @@ public function __construct(array $representation = [])
         }
     }
 
-    public function mark($place)
+    public function mark(string $place)
     {
         $this->places[$place] = 1;
     }
 
-    public function unmark($place)
+    public function unmark(string $place)
     {
         unset($this->places[$place]);
     }
 
-    public function has($place)
+    public function has(string $place)
     {
         return isset($this->places[$place]);
     }
diff --git a/src/Symfony/Component/Workflow/MarkingStore/MethodMarkingStore.php b/src/Symfony/Component/Workflow/MarkingStore/MethodMarkingStore.php
@@ -46,7 +46,7 @@ public function __construct(bool $singleState = false, string $property = 'marki
     /**
      * {@inheritdoc}
      */
-    public function getMarking($subject): Marking
+    public function getMarking(object $subject): Marking
     {
         $method = 'get'.ucfirst($this->property);
 
@@ -70,7 +70,7 @@ public function getMarking($subject): Marking
     /**
      * {@inheritdoc}
      */
-    public function setMarking($subject, Marking $marking, array $context = [])
+    public function setMarking(object $subject, Marking $marking, array $context = [])
     {
         $marking = $marking->getPlaces();
 
diff --git a/src/Symfony/Component/Workflow/Registry.php b/src/Symfony/Component/Workflow/Registry.php
@@ -28,12 +28,9 @@ public function addWorkflow(WorkflowInterface $workflow, WorkflowSupportStrategy
     }
 
     /**
-     * @param object      $subject
-     * @param string|null $workflowName
-     *
      * @return Workflow
      */
-    public function get($subject, $workflowName = null)
+    public function get(object $subject, string $workflowName = null)
     {
         $matched = null;
 
@@ -54,11 +51,9 @@ public function get($subject, $workflowName = null)
     }
 
     /**
-     * @param object $subject
-     *
      * @return Workflow[]
      */
-    public function all($subject): array
+    public function all(object $subject): array
     {
         $matched = [];
         foreach ($this->workflows as list($workflow, $supportStrategy)) {
diff --git a/src/Symfony/Component/Workflow/SupportStrategy/InstanceOfSupportStrategy.php b/src/Symfony/Component/Workflow/SupportStrategy/InstanceOfSupportStrategy.php
@@ -29,7 +29,7 @@ public function __construct(string $className)
     /**
      * {@inheritdoc}
      */
-    public function supports(WorkflowInterface $workflow, $subject): bool
+    public function supports(WorkflowInterface $workflow, object $subject): bool
     {
         return $subject instanceof $this->className;
     }
diff --git a/src/Symfony/Component/Workflow/SupportStrategy/WorkflowSupportStrategyInterface.php b/src/Symfony/Component/Workflow/SupportStrategy/WorkflowSupportStrategyInterface.php
@@ -18,5 +18,5 @@
  */
 interface WorkflowSupportStrategyInterface
 {
-    public function supports(WorkflowInterface $workflow, $subject): bool;
+    public function supports(WorkflowInterface $workflow, object $subject): bool;
 }
diff --git a/src/Symfony/Component/Workflow/Validator/DefinitionValidatorInterface.php b/src/Symfony/Component/Workflow/Validator/DefinitionValidatorInterface.php
@@ -21,10 +21,7 @@
 interface DefinitionValidatorInterface
 {
     /**
-     * @param Definition $definition
-     * @param string     $name
-     *
      * @throws InvalidDefinitionException on invalid definition
      */
-    public function validate(Definition $definition, $name);
+    public function validate(Definition $definition, string $name);
 }
diff --git a/src/Symfony/Component/Workflow/Validator/StateMachineValidator.php b/src/Symfony/Component/Workflow/Validator/StateMachineValidator.php
@@ -19,7 +19,7 @@
  */
 class StateMachineValidator implements DefinitionValidatorInterface
 {
-    public function validate(Definition $definition, $name)
+    public function validate(Definition $definition, string $name)
     {
         $transitionFromNames = [];
         foreach ($definition->getTransitions() as $transition) {
diff --git a/src/Symfony/Component/Workflow/Validator/WorkflowValidator.php b/src/Symfony/Component/Workflow/Validator/WorkflowValidator.php
@@ -27,7 +27,7 @@ public function __construct(bool $singlePlace = false)
         $this->singlePlace = $singlePlace;
     }
 
-    public function validate(Definition $definition, $name)
+    public function validate(Definition $definition, string $name)
     {
         // Make sure all transitions for one place has unique name.
         $places = array_fill_keys($definition->getPlaces(), []);
diff --git a/src/Symfony/Component/Workflow/Workflow.php b/src/Symfony/Component/Workflow/Workflow.php
@@ -49,7 +49,7 @@ public function __construct(Definition $definition, MarkingStoreInterface $marki
     /**
      * {@inheritdoc}
      */
-    public function getMarking($subject)
+    public function getMarking(object $subject)
     {
         $marking = $this->markingStore->getMarking($subject);
 
@@ -91,7 +91,7 @@ public function getMarking($subject)
     /**
      * {@inheritdoc}
      */
-    public function can($subject, $transitionName)
+    public function can(object $subject, string $transitionName)
     {
         $transitions = $this->definition->getTransitions();
         $marking = $this->getMarking($subject);
@@ -114,7 +114,7 @@ public function can($subject, $transitionName)
     /**
      * {@inheritdoc}
      */
-    public function buildTransitionBlockerList($subject, string $transitionName): TransitionBlockerList
+    public function buildTransitionBlockerList(object $subject, string $transitionName): TransitionBlockerList
     {
         $transitions = $this->definition->getTransitions();
         $marking = $this->getMarking($subject);
@@ -150,7 +150,7 @@ public function buildTransitionBlockerList($subject, string $transitionName): Tr
     /**
      * {@inheritdoc}
      */
-    public function apply($subject, $transitionName, array $context = [])
+    public function apply(object $subject, string $transitionName, array $context = [])
     {
         $marking = $this->getMarking($subject);
 
@@ -202,7 +202,7 @@ public function apply($subject, $transitionName, array $context = [])
     /**
      * {@inheritdoc}
      */
-    public function getEnabledTransitions($subject)
+    public function getEnabledTransitions(object $subject)
     {
         $enabledTransitions = [];
         $marking = $this->getMarking($subject);
@@ -249,7 +249,7 @@ public function getMetadataStore(): MetadataStoreInterface
         return $this->definition->getMetadataStore();
     }
 
-    private function buildTransitionBlockerListForTransition($subject, Marking $marking, Transition $transition)
+    private function buildTransitionBlockerListForTransition(object $subject, Marking $marking, Transition $transition)
     {
         foreach ($transition->getFroms() as $place) {
             if (!$marking->has($place)) {
@@ -272,7 +272,7 @@ private function buildTransitionBlockerListForTransition($subject, Marking $mark
         return new TransitionBlockerList();
     }
 
-    private function guardTransition($subject, Marking $marking, Transition $transition): ?GuardEvent
+    private function guardTransition(object $subject, Marking $marking, Transition $transition): ?GuardEvent
     {
         if (null === $this->dispatcher) {
             return null;
@@ -287,7 +287,7 @@ private function guardTransition($subject, Marking $marking, Transition $transit
         return $event;
     }
 
-    private function leave($subject, Transition $transition, Marking $marking): void
+    private function leave(object $subject, Transition $transition, Marking $marking): void
     {
         $places = $transition->getFroms();
 
@@ -307,7 +307,7 @@ private function leave($subject, Transition $transition, Marking $marking): void
         }
     }
 
-    private function transition($subject, Transition $transition, Marking $marking, array $context): array
+    private function transition(object $subject, Transition $transition, Marking $marking, array $context): array
     {
         if (null === $this->dispatcher) {
             return $context;
@@ -323,7 +323,7 @@ private function transition($subject, Transition $transition, Marking $marking,
         return $event->getContext();
     }
 
-    private function enter($subject, Transition $transition, Marking $marking): void
+    private function enter(object $subject, Transition $transition, Marking $marking): void
     {
         $places = $transition->getTos();
 
@@ -343,7 +343,7 @@ private function enter($subject, Transition $transition, Marking $marking): void
         }
     }
 
-    private function entered($subject, Transition $transition = null, Marking $marking): void
+    private function entered(object $subject, ?Transition $transition, Marking $marking): void
     {
         if (null === $this->dispatcher) {
             return;
@@ -361,7 +361,7 @@ private function entered($subject, Transition $transition = null, Marking $marki
         }
     }
 
-    private function completed($subject, Transition $transition, Marking $marking): void
+    private function completed(object $subject, Transition $transition, Marking $marking): void
     {
         if (null === $this->dispatcher) {
             return;
@@ -374,7 +374,7 @@ private function completed($subject, Transition $transition, Marking $marking):
         $this->dispatcher->dispatch($event, sprintf('workflow.%s.completed.%s', $this->name, $transition->getName()));
     }
 
-    private function announce($subject, Transition $initialTransition, Marking $marking): void
+    private function announce(object $subject, Transition $initialTransition, Marking $marking): void
     {
         if (null === $this->dispatcher) {
             return;
diff --git a/src/Symfony/Component/Workflow/WorkflowInterface.php b/src/Symfony/Component/Workflow/WorkflowInterface.php

Original file line number	Diff line number	Diff line change
`@@ -61,8 +61,6 @@ public function clear()`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`/**`
`64`		`- * @param string $place`
`65`		`- *`
`66`	`64`	`* @return $this`
`67`	`65`	`*/`
`68`	`66`	`public function setInitialPlace($place)`
`@@ -73,11 +71,9 @@ public function setInitialPlace($place)`
`73`	`71`	`}`
`74`	`72`
`75`	`73`	`/**`
`76`		`- * @param string $place`
`77`		`- *`
`78`	`74`	`* @return $this`
`79`	`75`	`*/`
`80`		`- public function addPlace($place)`
	`76`	`+ public function addPlace(string $place)`
`81`	`77`	`{`
`82`	`78`	`if (!$this->places) {`
`83`	`79`	`$this->initialPlace = $place;`
Original file line number	Diff line number	Diff line change
`@@ -236,15 +236,15 @@ protected function endDot()`
`236`	`236`	`/**`
`237`	`237`	`* @internal`
`238`	`238`	`*/`
`239`		`- protected function dotize($id)`
	`239`	`+ protected function dotize(string $id)`
`240`	`240`	`{`
`241`	`241`	`return hash('sha1', $id);`
`242`	`242`	`}`
`243`	`243`
`244`	`244`	`/**`
`245`	`245`	`* @internal`
`246`	`246`	`*/`
`247`		`- protected function escape($value): string`
	`247`	`+ protected function escape(string $value): string`
`248`	`248`	`{`
`249`	`249`	`return \is_bool($value) ? ($value ? '1' : '0') : addslashes($value);`
`250`	`250`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,7 @@ class Event extends BaseEvent`
`27`	`27`	`private $transition;`
`28`	`28`	`private $workflow;`
`29`	`29`
`30`		`- /**`
`31`		`- * @param object $subject`
`32`		`- */`
`33`		`- public function __construct($subject, Marking $marking, Transition $transition = null, WorkflowInterface $workflow = null)`
	`30`	`+ public function __construct(object $subject, Marking $marking, Transition $transition = null, WorkflowInterface $workflow = null)`
`34`	`31`	`{`
`35`	`32`	`$this->subject = $subject;`
`36`	`33`	`$this->marking = $marking;`
`@@ -63,7 +60,7 @@ public function getWorkflowName()`
`63`	`60`	`return $this->workflow->getName();`
`64`	`61`	`}`
`65`	`62`
`66`		`- public function getMetadata(string $key, $subject)`
	`63`	`+ public function getMetadata(string $key, object $subject)`
`67`	`64`	`{`
`68`	`65`	`return $this->workflow->getMetadataStore()->getMetadata($key, $subject);`
`69`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,13 +16,9 @@`
`16`	`16`	`class GuardExpression`
`17`	`17`	`{`
`18`	`18`	`private $transition;`
`19`		`-`
`20`	`19`	`private $expression;`
`21`	`20`
`22`		`- /**`
`23`		`- * @param string $expression`
`24`		`- */`
`25`		`- public function __construct(Transition $transition, $expression)`
	`21`	`+ public function __construct(Transition $transition, string $expression)`
`26`	`22`	`{`
`27`	`23`	`$this->transition = $transition;`
`28`	`24`	`$this->expression = $expression;`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function __construct(array $configuration, ExpressionLanguage $expression`
`44`	`44`	`$this->validator = $validator;`
`45`	`45`	`}`
`46`	`46`
`47`		`- public function onTransition(GuardEvent $event, $eventName)`
	`47`	`+ public function onTransition(GuardEvent $event, string $eventName)`
`48`	`48`	`{`
`49`	`49`	`if (!isset($this->configuration[$eventName])) {`
`50`	`50`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class NotEnabledTransitionException extends TransitionException`
`23`	`23`	`{`
`24`	`24`	`private $transitionBlockerList;`
`25`	`25`
`26`		`- public function __construct($subject, string $transitionName, WorkflowInterface $workflow, TransitionBlockerList $transitionBlockerList)`
	`26`	`+ public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow, TransitionBlockerList $transitionBlockerList)`
`27`	`27`	`{`
`28`	`28`	`parent::__construct($subject, $transitionName, $workflow, sprintf('Transition "%s" is not enabled for workflow "%s".', $transitionName, $workflow->getName()));`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class TransitionException extends LogicException`
`23`	`23`	`private $transitionName;`
`24`	`24`	`private $workflow;`
`25`	`25`
`26`		`- public function __construct($subject, string $transitionName, WorkflowInterface $workflow, string $message)`
	`26`	`+ public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow, string $message)`
`27`	`27`	`{`
`28`	`28`	`parent::__construct($message);`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`class UndefinedTransitionException extends TransitionException`
`22`	`22`	`{`
`23`		`- public function __construct($subject, string $transitionName, WorkflowInterface $workflow)`
	`23`	`+ public function __construct(object $subject, string $transitionName, WorkflowInterface $workflow)`
`24`	`24`	`{`
`25`	`25`	`parent::__construct($subject, $transitionName, $workflow, sprintf('Transition "%s" is not defined for workflow "%s".', $transitionName, $workflow->getName()));`
`26`	`26`	`}`