symfony · mdeboer · Apr 12, 2021 · Apr 18, 2021 · Apr 18, 2021 · Apr 18, 2021
diff --git a/src/Symfony/Bridge/Doctrine/Form/DataTransformer/CollectionToArrayTransformer.php b/src/Symfony/Bridge/Doctrine/Form/DataTransformer/CollectionToArrayTransformer.php
@@ -18,13 +18,15 @@
 
 /**
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements DataTransformerInterface<Collection, array>
  */
 class CollectionToArrayTransformer implements DataTransformerInterface
 {
     /**
      * Transforms a collection into an array.
      *
-     * @return mixed An array of entities
+     * @return mixed[] An array of entities
      *
      * @throws TransformationFailedException
      */

diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php
@@ -20,6 +20,7 @@
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\FormTypeInterface;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -338,6 +339,13 @@ protected function createAccessDeniedException(string $message = 'Access Denied.
 
     /**
      * Creates and returns a Form instance from the type of the form.
+     *
+     * @template TData
+     * @template TFormType of FormTypeInterface<TData>
+     *
+     * @param class-string<TFormType> $type
+     *
+     * @return FormInterface<TData>
      */
     protected function createForm(string $type, $data = null, array $options = []): FormInterface
     {

diff --git a/src/Symfony/Component/Config/Resource/GlobResource.php b/src/Symfony/Component/Config/Resource/GlobResource.php
@@ -21,6 +21,8 @@
  *
  * @author Nicolas Grekas <[email protected]>
  *
+ * @implements \IteratorAggregate<mixed, \SplFileInfo>
+ *
  * @final
  */
 class GlobResource implements \IteratorAggregate, SelfCheckingResourceInterface

@@ -18,6 +18,8 @@
  * HelperSet represents a set of helpers to be used with a command.
  *
  * @author Fabien Potencier <[email protected]>
+ *
+ * @implements \IteratorAggregate<Helper>
  */
 class HelperSet implements \IteratorAggregate
 {
@@ -89,7 +91,7 @@ public function getCommand()
     }
 
     /**
-     * @return Helper[]
+     * @return \Traversable<Helper>
      */
     public function getIterator()
     {

diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -18,6 +18,8 @@
  * Crawler eases navigation of a list of \DOMNode objects.
  *
  * @author Fabien Potencier <[email protected]>
+ *
+ * @implements \IteratorAggregate<\DOMNode>
  */
 class Crawler implements \Countable, \IteratorAggregate
 {
@@ -1109,7 +1111,7 @@ public function count()
     }
 
     /**
-     * @return \ArrayIterator|\DOMNode[]
+     * @return \Traversable<\DOMNode>
      */
     public function getIterator()
     {

diff --git a/src/Symfony/Component/EventDispatcher/GenericEvent.php b/src/Symfony/Component/EventDispatcher/GenericEvent.php
@@ -19,6 +19,8 @@
  * Encapsulates events thus decoupling the observer from the subject they encapsulate.
  *
  * @author Drak <[email protected]>
+ *
+ * @implements \IteratorAggregate<string, mixed>
  */
 class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
 {
@@ -161,7 +163,7 @@ public function offsetExists($key)
     /**
      * IteratorAggregate for iterating over the object like an array.
      *
-     * @return \ArrayIterator
+     * @return \Traversable<string, mixed>
      */
     public function getIterator()
     {

diff --git a/src/Symfony/Component/Finder/Finder.php b/src/Symfony/Component/Finder/Finder.php
@@ -36,6 +36,8 @@
  *     $finder = Finder::create()->files()->name('*.php')->in(__DIR__);
  *
  * @author Fabien Potencier <[email protected]>
+ *
+ * @implements \IteratorAggregate<SplFileInfo>
  */
 class Finder implements \IteratorAggregate, \Countable
 {
@@ -601,7 +603,7 @@ public function in($dirs)
      *
      * This method implements the IteratorAggregate interface.
      *
-     * @return \Iterator|SplFileInfo[] An iterator
+     * @return \Traversable<SplFileInfo> An iterator
      *
      * @throws \LogicException if the in() method has not been called
      */

@@ -17,6 +17,9 @@
 
 /**
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @template T
+ * @implements FormTypeInterface<T>
  */
 abstract class AbstractType implements FormTypeInterface
 {

@@ -15,6 +15,9 @@
 
 /**
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @template T
+ * @implements FormTypeExtensionInterface<T>
  */
 abstract class AbstractTypeExtension implements FormTypeExtensionInterface
 {

@@ -18,6 +18,10 @@
  * A form button.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @template T
+ *
+ * @implements FormInterface<T>
  */
 class Button implements \IteratorAggregate, FormInterface
 {

@@ -19,6 +19,10 @@
  * A builder for {@link Button} instances.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @template T
+ *
+ * @implements FormBuilderInterface<T>
  */
 class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
 {
@@ -135,7 +139,7 @@ public function all()
     /**
      * Creates the button.
      *
-     * @return Button The button
+     * @return FormInterface<T> The button
      */
     public function getForm()
     {

@@ -11,14 +11,20 @@
 
 namespace Symfony\Component\Form;
 
+/**
+ * @template T
+ * @template R
+ *
+ * @implements DataTransformerInterface<T, R>
+ */
 class CallbackTransformer implements DataTransformerInterface
 {
     private $transform;
     private $reverseTransform;
 
     /**
-     * @param callable $transform        The forward transform callback
-     * @param callable $reverseTransform The reverse transform callback
+     * @param callable(T):R $transform        The forward transform callback
+     * @param callable(R):T $reverseTransform The reverse transform callback
      */
     public function __construct(callable $transform, callable $reverseTransform)
     {

@@ -15,6 +15,8 @@
  * Represents a group of choices in templates.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \IteratorAggregate<self|ChoiceView>
  */
 class ChoiceGroupView implements \IteratorAggregate
 {
@@ -35,7 +37,7 @@ public function __construct(string $label, array $choices = [])
     /**
      * {@inheritdoc}
      *
-     * @return self[]|ChoiceView[]
+     * @return \Traversable<self|ChoiceView>
      */
     public function getIterator()
     {

@@ -17,6 +17,9 @@
  * Transforms a value between different representations.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @template T
+ * @template R
  */
 interface DataTransformerInterface
 {
@@ -53,9 +56,9 @@ interface DataTransformerInterface
      * of the first data transformer outputs NULL, the second must be able to
      * process that value.
      *
-     * @param mixed $value The value in the original representation
+     * @param T $value The value in the original representation
      *
-     * @return mixed The value in the transformed representation
+     * @return R The value in the transformed representation
      *
      * @throws TransformationFailedException when the transformation fails
      */
@@ -82,9 +85,9 @@ public function transform($value);
      * By convention, reverseTransform() should return NULL if an empty string
      * is passed.
      *
-     * @param mixed $value The value in the transformed representation
+     * @param R $value The value in the transformed representation
      *
-     * @return mixed The value in the original representation
+     * @return T The value in the original representation
      *
      * @throws TransformationFailedException when the transformation fails
      */

@@ -17,6 +17,9 @@
  * This event is dispatched at the end of the Form::setData() method.
  *
  * This event is mostly here for reading data after having pre-populated the form.
+ *
+ * @template T
+ * @extends FormEvent<T>
  */
 final class PostSetDataEvent extends FormEvent
 {

@@ -19,6 +19,9 @@
  * It can be used to:
  *  - Modify the data given during pre-population;
  *  - Modify a form depending on the pre-populated data (adding or removing fields dynamically).
+ *
+ * @template T
+ * @extends FormEvent<T>
  */
 final class PreSetDataEvent extends FormEvent
 {

@@ -19,6 +19,8 @@
  * It can be used to:
  *  - Change data from the request, before submitting the data to the form.
  *  - Add or remove form fields, before submitting the data to the form.
+ *
+ * @extends FormEvent<array<string, mixed>>
  */
 final class PreSubmitEvent extends FormEvent
 {

@@ -18,6 +18,9 @@
  * transforms back the normalized data to the model and view data.
  *
  * It can be used to change data from the normalized representation of the data.
+ *
+ * @template T
+ * @extends FormEvent<T>
  */
 final class SubmitEvent extends FormEvent
 {

@@ -16,6 +16,8 @@
 
 /**
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements DataTransformerInterface<array|null, array|null>
  */
 class ArrayToPartsTransformer implements DataTransformerInterface
 {

@@ -14,6 +14,12 @@
 use Symfony\Component\Form\DataTransformerInterface;
 use Symfony\Component\Form\Exception\InvalidArgumentException;
 
+/**
+ * @template T
+ * @template R
+ *
+ * @implements DataTransformerInterface<T, R>
+ */
 abstract class BaseDateTimeTransformer implements DataTransformerInterface
 {
     protected static $formats = [

@@ -20,6 +20,8 @@
  *
  * @author Bernhard Schussek <[email protected]>
  * @author Florian Eckerstorfer <[email protected]>
+ *
+ * @implements DataTransformerInterface<bool, string>
  */
 class BooleanToStringTransformer implements DataTransformerInterface
 {

@@ -17,6 +17,8 @@
 
 /**
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements DataTransformerInterface<mixed, string>
  */
 class ChoiceToValueTransformer implements DataTransformerInterface
 {

@@ -17,6 +17,8 @@
 
 /**
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements DataTransformerInterface<array, string[]>
  */
 class ChoicesToValuesTransformer implements DataTransformerInterface
 {
@@ -28,7 +30,7 @@ public function __construct(ChoiceListInterface $choiceList)
     }
 
     /**
-     * @return array
+     * @return string[]
      *
      * @throws TransformationFailedException if the given value is not an array
      */

@@ -18,6 +18,8 @@
  * Passes a value through multiple value transformers.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements DataTransformerInterface<mixed, mixed>
  */
 class DataTransformerChain implements DataTransformerInterface
 {

@@ -19,6 +19,8 @@
  * Transforms between a normalized date interval and an interval string/array.
  *
  * @author Steffen Roßkamp <[email protected]>
+ *
+ * @implements DataTransformerInterface<\DateInterval, array>
  */
 class DateIntervalToArrayTransformer implements DataTransformerInterface
 {

@@ -19,6 +19,8 @@
  * Transforms between a date string and a DateInterval object.
  *
  * @author Steffen Roßkamp <[email protected]>
+ *
+ * @implements DataTransformerInterface<\DateInterval, string>
  */
 class DateIntervalToStringTransformer implements DataTransformerInterface
 {

@@ -18,6 +18,8 @@
  * Transforms between a DateTimeImmutable object and a DateTime object.
  *
  * @author Valentin Udaltsov <[email protected]>
+ *
+ * @implements DataTransformerInterface<\DateTimeImmutable|null, \DateTime|null>
  */
 final class DateTimeImmutableToDateTimeTransformer implements DataTransformerInterface
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,8 @@ @@
     /**
      * @author Bernhard Schussek <[email protected]>
+     *
+     * @implements DataTransformerInterface<array|null, array|null>
      */
     class ArrayToPartsTransformer implements DataTransformerInterface
     {
@@ Expand Down @@