Add property types and return types in constraints and few other places

Author: alexandre-daubois

cache.rst

@@ -363,7 +363,7 @@ with either :class:`Symfony\\Contracts\\Cache\\CacheInterface` or
             // config/services.php
             namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
-            return function(ContainerConfigurator $container) {
+            return function(ContainerConfigurator $container): void {
                 $container->services()
                     // ...
 

components/options_resolver.rst

@@ -23,7 +23,7 @@ Imagine you have a ``Mailer`` class which has four options: ``host``,
 
     class Mailer
     {
-        protected $options;
+        protected array $options;
 
         public function __construct(array $options = [])
         {
@@ -37,7 +37,7 @@ check which options are set::
     class Mailer
     {
         // ...
-        public function sendMail($from, $to)
+        public function sendMail($from, $to): void
         {
             $mail = ...;
 
@@ -884,9 +884,9 @@ can change your code to do the configuration only once per class::
     // ...
     class Mailer
     {
-        private static $resolversByClass = [];
+        private static array $resolversByClass = [];
 
-        protected $options;
+        protected array $options;
 
         public function __construct(array $options = [])
         {
@@ -902,7 +902,7 @@ can change your code to do the configuration only once per class::
             $this->options = self::$resolversByClass[$class]->resolve($options);
         }
 
-        public function configureOptions(OptionsResolver $resolver)
+        public function configureOptions(OptionsResolver $resolver): void
         {
             // ...
         }
@@ -917,9 +917,9 @@ method ``clearOptionsConfig()`` and call it periodically::
     // ...
     class Mailer
     {
-        private static $resolversByClass = [];
+        private static array $resolversByClass = [];
 
-        public static function clearOptionsConfig()
+        public static function clearOptionsConfig(): void
         {
             self::$resolversByClass = [];
         }

components/serializer.rst

@@ -73,7 +73,7 @@ exists in your project::
         private int $age;
         private string $name;
         private bool $sportsperson;
-        private ?\DateTime $createdAt;
+        private ?\DateTimeInterface $createdAt;
 
         // Getters
         public function getAge(): int
@@ -113,7 +113,7 @@ exists in your project::
             $this->sportsperson = $sportsperson;
         }
 
-        public function setCreatedAt(\DateTime $createdAt = null): void
+        public function setCreatedAt(\DateTimeInterface $createdAt = null): void
         {
             $this->createdAt = $createdAt;
         }
@@ -607,11 +607,11 @@ processes::
     class Person
     {
         public function __construct(
-            private $firstName,
+            private string $firstName,
         ) {
         }
 
-        public function getFirstName()
+        public function getFirstName(): string
         {
             return $this->firstName;
         }
@@ -663,7 +663,7 @@ defines a ``Person`` entity with a ``firstName`` property:
         {
             public function __construct(
                 #[SerializedName('customer_name')]
-                private $firstName,
+                private string $firstName,
             ) {
             }
 

components/validator/resources.rst

@@ -37,9 +37,9 @@ In this example, the validation metadata is retrieved executing the
 
     class User
     {
-        protected $name;
+        protected string $name;
 
-        public static function loadValidatorMetadata(ClassMetadata $metadata)
+        public static function loadValidatorMetadata(ClassMetadata $metadata): void
         {
             $metadata->addPropertyConstraint('name', new Assert\NotBlank());
             $metadata->addPropertyConstraint('name', new Assert\Length([
@@ -99,7 +99,7 @@ prefixed classes included in doc block comments (``/** ... */``). For example::
         /**
          * @Assert\NotBlank
          */
-        protected $name;
+        protected string $name;
     }
 
 To enable the annotation loader, call the

components/var_dumper.rst

@@ -372,9 +372,9 @@ then its dump representation::
 
     class PropertyExample
     {
-        public $publicProperty = 'The `+` prefix denotes public properties,';
-        protected $protectedProperty = '`#` protected ones and `-` private ones.';
-        private $privateProperty = 'Hovering a property shows a reminder.';
+        public string $publicProperty = 'The `+` prefix denotes public properties,';
+        protected string $protectedProperty = '`#` protected ones and `-` private ones.';
+        private string $privateProperty = 'Hovering a property shows a reminder.';
     }
 
     $var = new PropertyExample();
@@ -391,7 +391,7 @@ then its dump representation::
 
     class DynamicPropertyExample
     {
-        public $declaredProperty = 'This property is declared in the class definition';
+        public string $declaredProperty = 'This property is declared in the class definition';
     }
 
     $var = new DynamicPropertyExample();
@@ -404,7 +404,7 @@ then its dump representation::
 
     class ReferenceExample
     {
-        public $info = "Circular and sibling references are displayed as `#number`.\nHovering them highlights all instances in the same dump.\n";
+        public string $info = "Circular and sibling references are displayed as `#number`.\nHovering them highlights all instances in the same dump.\n";
     }
     $var = new ReferenceExample();
     $var->aCircularReference = $var;

components/var_exporter.rst

@@ -50,10 +50,10 @@ following class hierarchy::
 
     abstract class AbstractClass
     {
-        protected $foo;
-        private $bar;
+        protected int $foo;
+        private int $bar;
 
-        protected function setBar($bar)
+        protected function setBar($bar): void
         {
             $this->bar = $bar;
         }

doctrine/resolve_target_entity.rst

@@ -65,11 +65,8 @@ An Invoice entity::
     #[ORM\Table(name: 'invoice')]
     class Invoice
     {
-        /**
-         * @var InvoiceSubjectInterface
-         */
         #[ORM\ManyToOne(targetEntity: InvoiceSubjectInterface::class)]
-        protected $subject;
+        protected InvoiceSubjectInterface $subject;
     }
 
 An InvoiceSubjectInterface::

event_dispatcher.rst

@@ -91,7 +91,7 @@ notify Symfony that it is an event listener by using a special "tag":
 
         use App\EventListener\ExceptionListener;
 
-        return function(ContainerConfigurator $container) {
+        return function(ContainerConfigurator $container): void {
             $services = $container->services();
 
             $services->set(ExceptionListener::class)

form/bootstrap5.rst

@@ -57,7 +57,7 @@ configuration:
         // config/packages/twig.php
         use Symfony\Config\TwigConfig;
 
-        return static function(TwigConfig $twig) {
+        return static function(TwigConfig $twig): void {
             $twig->formThemes(['bootstrap_5_layout.html.twig']);
 
             // ...

form/form_collections.rst

@@ -16,8 +16,8 @@ Let's start by creating a ``Task`` entity::
 
     class Task
     {
-        protected $description;
-        protected $tags;
+        protected string $description;
+        protected ArrayCollection $tags;
 
         public function __construct()
         {
@@ -53,7 +53,7 @@ objects::
 
     class Tag
     {
-        private $name;
+        private string $name;
 
         public function getName(): string
         {
@@ -466,7 +466,7 @@ you will learn about next!).
             // ...
 
             #[ORM\ManyToMany(targetEntity: Tag::class, cascade: ['persist'])]
-            protected $tags;
+            protected array $tags;
 
         .. code-block:: yaml