Add wither behavior with PHP8 static return type

l-vo · l-vo · commit 66527dfa3210 · 2020-05-03T21:41:05.000+02:00
diff --git a/service_container/calls.rst b/service_container/calls.rst
@@ -88,9 +88,6 @@ instead of mutating the object they were called on::
     {
         private $logger;
 
-        /**
-         * @return static
-         */
         public function withLogger(LoggerInterface $logger)
         {
             $new = clone $this;
@@ -144,3 +141,21 @@ The configuration to tell the container it should do so would be like:
 
         $container->register(MessageGenerator::class)
             ->addMethodCall('withLogger', [new Reference('logger')], true);
+
+If autowire is enabled, you can also use annotations; with the previous example it would be:
+
+    .. code-block:: php
+
+        /**
+         * @required
+         * @return static
+         */
+        public function withLogger(LoggerInterface $logger)
+        {
+            $new = clone $this;
+            $new->logger = $logger;
+
+            return $new;
+        }
+
+You can also leverage the PHP8 `static` return type instead of the `@return static` annotation. Note if you don't want a method with a PHP8 `static` return type and a `@required` annotation to behave as a wither, you can add a `@return $this` annotation to disable the *returns clone* feature.
