[2.3] [DI] Improve the generated PHPDoc of the dumped PHP container

vicb · fabpot · commit 9024c07d0335 · 2013-03-06T18:58:05.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -441,19 +441,30 @@ private function addService($id, $definition)
         $this->referenceVariables = array();
         $this->variableCount = 0;
 
-        $return = '';
+        $return = array();
+
         if ($definition->isSynthetic()) {
-            $return = sprintf('@throws RuntimeException always since this service is expected to be injected dynamically');
+            $return[] = '@throws RuntimeException always since this service is expected to be injected dynamically';
         } elseif ($class = $definition->getClass()) {
-            $return = sprintf("@return %s A %s instance.", 0 === strpos($class, '%') ? 'Object' : $class, $class);
+            $return[] = sprintf("@return %s A %s instance.", 0 === strpos($class, '%') ? 'object' : $class, $class);
         } elseif ($definition->getFactoryClass()) {
-            $return = sprintf('@return Object An instance returned by %s::%s().', $definition->getFactoryClass(), $definition->getFactoryMethod());
+            $return[] = sprintf('@return object An instance returned by %s::%s().', $definition->getFactoryClass(), $definition->getFactoryMethod());
         } elseif ($definition->getFactoryService()) {
-            $return = sprintf('@return Object An instance returned by %s::%s().', $definition->getFactoryService(), $definition->getFactoryMethod());
+            $return[] = sprintf('@return object An instance returned by %s::%s().', $definition->getFactoryService(), $definition->getFactoryMethod());
+        }
+
+        $scope = $definition->getScope();
+        if (!in_array($scope, array(ContainerInterface::SCOPE_CONTAINER, ContainerInterface::SCOPE_PROTOTYPE))) {
+            if ($return && 0 === strpos($return[count($return) - 1], '@return')) {
+                $return[] = '';
+            }
+            $return[] = sprintf("@throws InactiveScopeException when the '%s' service is requested while the '%s' scope is not active", $id, $scope);
         }
 
+        $return = implode("\n     * ", $return);
+
         $doc = '';
-        if (ContainerInterface::SCOPE_PROTOTYPE !== $definition->getScope()) {
+        if (ContainerInterface::SCOPE_PROTOTYPE !== $scope) {
             $doc .= <<<EOF
 
      *
@@ -484,8 +495,7 @@ protected function get{$name}Service()
 
 EOF;
 
-        $scope = $definition->getScope();
-        if (ContainerInterface::SCOPE_CONTAINER !== $scope && ContainerInterface::SCOPE_PROTOTYPE !== $scope) {
+        if (!in_array($scope, array(ContainerInterface::SCOPE_CONTAINER, ContainerInterface::SCOPE_PROTOTYPE))) {
             $code .= <<<EOF
         if (!isset(\$this->scopedServices['$scope'])) {
             throw new InactiveScopeException('$id', '$scope');
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9.php
@@ -102,7 +102,7 @@ protected function getFooService()
      * This service is shared.
      * This method always returns the same instance of the service.
      *
-     * @return Object A %baz_class% instance.
+     * @return object A %baz_class% instance.
      */
     protected function getFoo_BazService()
     {
@@ -116,7 +116,7 @@ protected function getFoo_BazService()
     /**
      * Gets the 'foo_bar' service.
      *
-     * @return Object A %foo_class% instance.
+     * @return object A %foo_class% instance.
      */
     protected function getFooBarService()
     {

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ protected function getFooService()`
`102`	`102`	`* This service is shared.`
`103`	`103`	`* This method always returns the same instance of the service.`
`104`	`104`	`*`
`105`		`- * @return Object A %baz_class% instance.`
	`105`	`+ * @return object A %baz_class% instance.`
`106`	`106`	`*/`
`107`	`107`	`protected function getFoo_BazService()`
`108`	`108`	`{`
`@@ -116,7 +116,7 @@ protected function getFoo_BazService()`
`116`	`116`	`/**`
`117`	`117`	`* Gets the 'foo_bar' service.`
`118`	`118`	`*`
`119`		`- * @return Object A %foo_class% instance.`
	`119`	`+ * @return object A %foo_class% instance.`
`120`	`120`	`*/`
`121`	`121`	`protected function getFooBarService()`
`122`	`122`	`{`