minor #21315 [DI][FrameworkBundle] Show autowired methods in descriptors (ogizanagi)

This PR was merged into the 3.3-dev branch.

Discussion
----------

[DI][FrameworkBundle] Show autowired methods in descriptors

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | N/A

so we can see the autowired methods using `debug:container`.

Commits
-------

482435c501 [DI][FrameworkBundle] Show autowired methods in descriptors

Author: fabpot

Console/Descriptor/JsonDescriptor.php

@@ -220,9 +220,13 @@ private function getContainerDefinitionData(Definition $definition, $omitTags =
             'lazy' => $definition->isLazy(),
             'shared' => $definition->isShared(),
             'abstract' => $definition->isAbstract(),
-            'autowire' => $definition->isAutowired(),
         );
 
+        $autowiredCalls = array_values(array_filter($definition->getAutowiredCalls(), function ($method) {
+            return $method !== '__construct';
+        }));
+        $data['autowire'] = $definition->isAutowired() ? ($autowiredCalls ?: true) : false;
+
         foreach ($definition->getAutowiringTypes(false) as $autowiringType) {
             $data['autowiring_types'][] = $autowiringType;
         }

Console/Descriptor/MarkdownDescriptor.php

@@ -182,9 +182,16 @@ protected function describeContainerDefinition(Definition $definition, array $op
             ."\n".'- Lazy: '.($definition->isLazy() ? 'yes' : 'no')
             ."\n".'- Shared: '.($definition->isShared() ? 'yes' : 'no')
             ."\n".'- Abstract: '.($definition->isAbstract() ? 'yes' : 'no')
-            ."\n".'- Autowired: '.($definition->isAutowired() ? 'yes' : 'no')
         ;
 
+        $autowiredCalls = array_filter($definition->getAutowiredCalls(), function ($method) {
+            return $method !== '__construct';
+        });
+        $output .= "\n".'- Autowire: ';
+        $output .= $definition->isAutowired() ? ($autowiredCalls ? implode(', ', array_map(function ($method) {
+            return "`$method`";
+        }, $autowiredCalls)) : 'yes') : 'no';
+
         foreach ($definition->getAutowiringTypes(false) as $autowiringType) {
             $output .= "\n".'- Autowiring Type: `'.$autowiringType.'`';
         }

Console/Descriptor/TextDescriptor.php

@@ -295,7 +295,11 @@ protected function describeContainerDefinition(Definition $definition, array $op
         $tableRows[] = array('Lazy', $definition->isLazy() ? 'yes' : 'no');
         $tableRows[] = array('Shared', $definition->isShared() ? 'yes' : 'no');
         $tableRows[] = array('Abstract', $definition->isAbstract() ? 'yes' : 'no');
-        $tableRows[] = array('Autowired', $definition->isAutowired() ? 'yes' : 'no');
+
+        $autowiredCalls = array_filter($definition->getAutowiredCalls(), function ($method) {
+            return $method !== '__construct';
+        });
+        $tableRows[] = array('Autowire', $definition->isAutowired() ? ($autowiredCalls ? implode("\n", $autowiredCalls) : 'yes') : 'no');
 
         if ($autowiringTypes = $definition->getAutowiringTypes(false)) {
             $tableRows[] = array('Autowiring Types', implode(', ', $autowiringTypes));

Console/Descriptor/XmlDescriptor.php

@@ -374,6 +374,18 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu
         $serviceXML->setAttribute('autowired', $definition->isAutowired() ? 'true' : 'false');
         $serviceXML->setAttribute('file', $definition->getFile());
 
+        $autowiredCalls = array_filter($definition->getAutowiredCalls(), function ($method) {
+            return $method !== '__construct';
+        });
+        if ($autowiredCalls) {
+            $serviceXML->appendChild($autowiredMethodsXML = $dom->createElement('autowired-calls'));
+            foreach ($autowiredCalls as $autowiredMethod) {
+                $autowiredMethodXML = $dom->createElement('autowired-call');
+                $autowiredMethodXML->appendChild(new \DOMText($autowiredMethod));
+                $autowiredMethodsXML->appendChild($autowiredMethodXML);
+            }
+        }
+
         $calls = $definition->getMethodCalls();
         if (count($calls) > 0) {
             $serviceXML->appendChild($callsXML = $dom->createElement('calls'));

Tests/Console/Descriptor/ObjectsProvider.php

@@ -137,6 +137,9 @@ public static function getContainerDefinitions()
                 ->addTag('tag2')
                 ->addMethodCall('setMailer', array(new Reference('mailer')))
                 ->setFactory(array(new Reference('factory.service'), 'get')),
+            'definition_autowired' => (new Definition('AutowiredService'))->setAutowired(true),
+            'definition_autowired_with_methods' => (new Definition('AutowiredService'))
+                ->setAutowiredCalls(array('__construct', 'set*', 'addFoo')),
         );
     }
 

Tests/Fixtures/Descriptor/alias_with_definition_1.md

@@ -11,6 +11,6 @@
 - Lazy: yes
 - Shared: yes
 - Abstract: yes
-- Autowired: no
+- Autowire: no
 - Factory Class: `Full\Qualified\FactoryClass`
 - Factory Method: `get`

Tests/Fixtures/Descriptor/alias_with_definition_1.txt

@@ -14,7 +14,7 @@
   Lazy             yes                          
   Shared           yes                          
   Abstract         yes                          
-  Autowired        no                           
+  Autowire         no                           
   Factory Class    Full\Qualified\FactoryClass  
   Factory Method   get                          
  ---------------- -----------------------------

Tests/Fixtures/Descriptor/alias_with_definition_2.md

@@ -11,7 +11,7 @@
 - Lazy: no
 - Shared: yes
 - Abstract: no
-- Autowired: no
+- Autowire: no
 - File: `/path/to/file`
 - Factory Service: `factory.service`
 - Factory Method: `get`

Tests/Fixtures/Descriptor/alias_with_definition_2.txt

@@ -17,7 +17,7 @@
   Lazy              no                               
   Shared            yes                              
   Abstract          no                               
-  Autowired         no                               
+  Autowire          no                               
   Required File     /path/to/file                    
   Factory Service   factory.service                  
   Factory Method    get                              

Tests/Fixtures/Descriptor/builder_1_arguments.json

@@ -80,6 +80,33 @@
             "factory_class": "Full\\Qualified\\FactoryClass",
             "factory_method": "get",
             "tags": []
+        },
+        "definition_autowired": {
+            "class": "AutowiredService",
+            "public": true,
+            "synthetic": false,
+            "lazy": false,
+            "shared": true,
+            "abstract": false,
+            "autowire": true,
+            "arguments": [],
+            "file": null,
+            "tags": []
+        },
+        "definition_autowired_with_methods": {
+            "class": "AutowiredService",
+            "public": true,
+            "synthetic": false,
+            "lazy": false,
+            "shared": true,
+            "abstract": false,
+            "autowire": [
+                "set*",
+                "addFoo"
+            ],
+            "arguments": [],
+            "file": null,
+            "tags": []
         }
     },
     "aliases": {