minor #14394 [DependencyInjection] Document the Required attribute (derrabus)

javiereguiluz · javiereguiluz · commit 95b8a38f23fc · 2020-10-17T19:42:26.000+02:00
This PR was merged into the 5.x branch. Discussion ---------- [DependencyInjection] Document the Required attribute This PR adds documentation for symfony/symfony#37545 and fixes #14189. Commits ------- 701f704 [DependencyInjection] Document the Required attribute.
diff --git a/service_container/autowiring.rst b/service_container/autowiring.rst
@@ -544,50 +544,107 @@ Autowiring other Methods (e.g. Setters and Public Typed Properties)
 
 When autowiring is enabled for a service, you can *also* configure the container
 to call methods on your class when it's instantiated. For example, suppose you want
-to inject the ``logger`` service, and decide to use setter-injection::
+to inject the ``logger`` service, and decide to use setter-injection:
 
-    // src/Util/Rot13Transformer.php
-    namespace App\Util;
+.. configuration-block::
 
-    class Rot13Transformer
-    {
-        private $logger;
+    .. code-block:: php-annotations
 
-        /**
-         * @required
-         */
-        public function setLogger(LoggerInterface $logger)
+        // src/Util/Rot13Transformer.php
+        namespace App\Util;
+
+        class Rot13Transformer
         {
-            $this->logger = $logger;
+            private $logger;
+
+            /**
+            * @required
+            */
+            public function setLogger(LoggerInterface $logger)
+            {
+                $this->logger = $logger;
+            }
+
+            public function transform($value)
+            {
+                $this->logger->info('Transforming '.$value);
+                // ...
+            }
         }
 
-        public function transform($value)
+    .. code-block:: php-attributes
+
+        // src/Util/Rot13Transformer.php
+        namespace App\Util;
+
+        use Symfony\Contracts\Service\Attribute\Required;
+
+        class Rot13Transformer
         {
-            $this->logger->info('Transforming '.$value);
-            // ...
+            private $logger;
+
+            #[Required]
+            public function setLogger(LoggerInterface $logger)
+            {
+                $this->logger = $logger;
+            }
+
+            public function transform($value)
+            {
+                $this->logger->info('Transforming '.$value);
+                // ...
+            }
         }
-    }
 
-Autowiring will automatically call *any* method with the ``@required`` annotation
+Autowiring will automatically call *any* method with the ``#[Required]`` attribute
 above it, autowiring each argument. If you need to manually wire some of the arguments
 to a method, you can always explicitly :doc:`configure the method call </service_container/calls>`.
 
-Despite property injection has some :ref:`drawbacks <property-injection>`, autowiring with ``@required`` annotation
-can also be applied to public typed properties::
+If you need to stay compatible with PHP 7 and thus cannot use attributes, you can use
+the ``@required`` annotation instead.
 
-    namespace App\Util;
+.. versionadded:: 5.2
 
-    class Rot13Transformer
-    {
-        /** @required */
-        public LoggerInterface $logger;
+    The ``#[Required]`` attribute was introduced in Symfony 5.2.
 
-        public function transform($value)
+Despite property injection has some :ref:`drawbacks <property-injection>`, autowiring with ``#[Required]``
+or ``@required`` can also be applied to public typed properties::
+
+.. configuration-block::
+
+    .. code-block:: php-annotations
+
+        namespace App\Util;
+
+        class Rot13Transformer
         {
-            $this->logger->info('Transforming '.$value);
-            // ...
+            /** @required */
+            public LoggerInterface $logger;
+
+            public function transform($value)
+            {
+                $this->logger->info('Transforming '.$value);
+                // ...
+            }
+        }
+
+    .. code-block:: php-attributes
+
+        namespace App\Util;
+
+        use Symfony\Contracts\Service\Attribute\Required;
+
+        class Rot13Transformer
+        {
+            #[Required]
+            public LoggerInterface $logger;
+
+            public function transform($value)
+            {
+                $this->logger->info('Transforming '.$value);
+                // ...
+            }
         }
-    }
 
 .. versionadded:: 5.1
 
diff --git a/service_container/calls.rst b/service_container/calls.rst
@@ -6,7 +6,7 @@ Service Method Calls and Setter Injection
 
 .. tip::
 
-    If you're using autowiring, you can use ``@required`` to
+    If you're using autowiring, you can use ``#[Required]`` or ``@required`` to
     :ref:`automatically configure method calls <autowiring-calls>`.
 
 Usually, you'll want to inject your dependencies via the constructor. But sometimes,
