feature #18416 [FrameworkBundle] Calls support for debug:container (JhonnyL)

This PR was merged into the 3.1-dev branch.

Discussion
----------

[FrameworkBundle] Calls support for debug:container

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

* Show methods to be called after service initialization in `debug:container` command

Commits
-------

b2d1038 [FrameworkBundle] Calls support for debug:container

Author: fabpot

Console/Descriptor/JsonDescriptor.php

@@ -242,6 +242,14 @@ private function getContainerDefinitionData(Definition $definition, $omitTags =
             }
         }
 
+        $calls = $definition->getMethodCalls();
+        if (count($calls) > 0) {
+            $data['calls'] = array();
+            foreach ($calls as $callData) {
+                $data['calls'][] = $callData[0];
+            }
+        }
+
         if (!$omitTags) {
             $data['tags'] = array();
             if (count($definition->getTags())) {

Console/Descriptor/MarkdownDescriptor.php

@@ -214,6 +214,11 @@ protected function describeContainerDefinition(Definition $definition, array $op
             }
         }
 
+        $calls = $definition->getMethodCalls();
+        foreach ($calls as $callData) {
+            $output .= "\n".'- Call: `'.$callData[0].'`';
+        }
+
         if (!(isset($options['omit_tags']) && $options['omit_tags'])) {
             foreach ($definition->getTags() as $tagName => $tagData) {
                 foreach ($tagData as $parameters) {

Console/Descriptor/TextDescriptor.php

@@ -275,6 +275,15 @@ protected function describeContainerDefinition(Definition $definition, array $op
         }
         $tableRows[] = array('Tags', $tagInformation);
 
+        $calls = $definition->getMethodCalls();
+        if (count($calls) > 0) {
+            $callInformation = [];
+            foreach ($calls as $call) {
+                $callInformation[] = $call[0];
+            }
+            $tableRows[] = array('Calls', implode(', ', $callInformation));
+        }
+
         $tableRows[] = array('Public', $definition->isPublic() ? 'yes' : 'no');
         $tableRows[] = array('Synthetic', $definition->isSynthetic() ? 'yes' : 'no');
         $tableRows[] = array('Lazy', $definition->isLazy() ? 'yes' : 'no');

Console/Descriptor/XmlDescriptor.php

@@ -360,6 +360,15 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu
 
         $serviceXML->setAttribute('file', $definition->getFile());
 
+        $calls = $definition->getMethodCalls();
+        if (count($calls) > 0) {
+            $serviceXML->appendChild($callsXML = $dom->createElement('calls'));
+            foreach ($calls as $callData) {
+                $callsXML->appendChild($callXML = $dom->createElement('call'));
+                $callXML->setAttribute('method', $callData[0]);
+            }
+        }
+
         if (!$omitTags) {
             $tags = $definition->getTags();
 

Tests/Console/Descriptor/ObjectsProvider.php

@@ -115,6 +115,7 @@ public static function getContainerDefinitions()
                 ->addTag('tag1', array('attr1' => 'val1', 'attr2' => 'val2'))
                 ->addTag('tag1', array('attr3' => 'val3'))
                 ->addTag('tag2')
+                ->addMethodCall('setMailer', array(new Reference('mailer')))
                 ->setFactory(array(new Reference('factory.service'), 'get')),
         );
     }

Tests/Fixtures/Descriptor/builder_1_services.json

@@ -47,6 +47,9 @@
                     ]
                 }
             ],
+            "calls": [
+                "setMailer"
+            ],
             "autowire": false,
             "autowiring_types": []
         }

Tests/Fixtures/Descriptor/builder_1_services.md

@@ -30,6 +30,7 @@ definition_2
 - File: `/path/to/file`
 - Factory Service: `factory.service`
 - Factory Method: `get`
+- Call: `setMailer`
 - Tag: `tag1`
     - Attr1: val1
     - Attr2: val2

Tests/Fixtures/Descriptor/builder_1_services.xml

@@ -7,6 +7,9 @@
   </definition>
   <definition id="definition_2" class="Full\Qualified\Class2" public="false" synthetic="true" lazy="false" shared="true" abstract="false" autowired="false" file="/path/to/file">
     <factory service="factory.service" method="get"/>
+    <calls>
+      <call method="setMailer"/>
+    </calls>
     <tags>
       <tag name="tag1">
         <parameter name="attr1">val1</parameter>

Tests/Fixtures/Descriptor/builder_1_tag1.json

@@ -31,6 +31,9 @@
                     ]
                 }
             ],
+            "calls": [
+                "setMailer"
+            ],
             "autowire": false,
             "autowiring_types": []
         }

Tests/Fixtures/Descriptor/builder_1_tag1.md

@@ -17,6 +17,7 @@ definition_2
 - File: `/path/to/file`
 - Factory Service: `factory.service`
 - Factory Method: `get`
+- Call: `setMailer`
 - Tag: `tag1`
     - Attr1: val1
     - Attr2: val2