minor symfony#23673 [DI] Make dumped docblocks less verbose (nicolas-grekas)

fabpot · fabpot · commit a90250d8da0a · 2017-07-26T09:36:19.000+02:00
This PR was merged into the 2.7 branch. Discussion ---------- [DI] Make dumped docblocks less verbose | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - When I open a dumped container, I always find there are too much noise in docblocs. As a bonus side effect, this will reduce the memory requirement in dev :) Commits ------- 1ade5d8 [DI] Make dumped docblocks less verbose
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -565,7 +565,7 @@ private function addService($id, Definition $definition)
         if ($definition->isSynthetic()) {
             $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' : '\\'.ltrim($class, '\\'), ltrim($class, '\\'));
+            $return[] = sprintf(0 === strpos($class, '%') ? '@return object A %1$s instance' : '@return \%s', ltrim($class, '\\'));
         } elseif ($definition->getFactory()) {
             $factory = $definition->getFactory();
             if (is_string($factory)) {
@@ -593,32 +593,13 @@ private function addService($id, Definition $definition)
 
         $return = implode("\n     * ", $return);
 
-        $doc = '';
-        if (ContainerInterface::SCOPE_PROTOTYPE !== $scope) {
-            $doc .= <<<'EOF'
-
-     *
-     * This service is shared.
-     * This method always returns the same instance of the service.
-EOF;
-        }
-
-        if (!$definition->isPublic()) {
-            $doc .= <<<'EOF'
-
-     *
-     * This service is private.
-     * If you want to be able to request this service from the container directly,
-     * make it public, otherwise you might end up with broken code.
-EOF;
-        }
+        $shared = ContainerInterface::SCOPE_PROTOTYPE !== $scope ? ' shared' : '';
+        $public = $definition->isPublic() ? 'public' : 'private';
 
         if ($definition->isLazy()) {
             $lazyInitialization = '$lazyLoad = true';
-            $lazyInitializationDoc = "\n     * @param bool    \$lazyLoad whether to try lazy-loading the service with a proxy\n     *";
         } else {
             $lazyInitialization = '';
-            $lazyInitializationDoc = '';
         }
 
         // with proxies, for 5.3.3 compatibility, the getter must be public to be accessible to the initializer
@@ -627,8 +608,8 @@ private function addService($id, Definition $definition)
         $code = <<<EOF
 
     /*{$this->docStar}
-     * Gets the '$id' service.$doc
-     *$lazyInitializationDoc
+     * Gets the $public '$id'$shared service.
+     *
      * $return
      */
     {$visibility} function get{$this->camelize($id)}Service($lazyInitialization)
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services10.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services10.php
@@ -55,12 +55,9 @@ public function isFrozen()
     }
 
     /**
-     * Gets the 'test' service.
+     * Gets the public 'test' shared service.
      *
-     * This service is shared.
-     * This method always returns the same instance of the service.
-     *
-     * @return \stdClass A stdClass instance
+     * @return \stdClass
      */
     protected function getTestService()
     {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services12.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services12.php
@@ -59,12 +59,9 @@ public function isFrozen()
     }
 
     /**
-     * Gets the 'test' service.
+     * Gets the public 'test' shared service.
      *
-     * This service is shared.
-     * This method always returns the same instance of the service.
-     *
-     * @return \stdClass A stdClass instance
+     * @return \stdClass
      */
     protected function getTestService()
     {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services13.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services13.php
@@ -53,12 +53,9 @@ public function isFrozen()
     }
 
     /**
-     * Gets the 'bar' service.
+     * Gets the public 'bar' shared service.
      *
-     * This service is shared.
-     * This method always returns the same instance of the service.
-     *
-     * @return \stdClass A stdClass instance
+     * @return \stdClass
      */
     protected function getBarService()
     {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services19.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services19.php
@@ -32,25 +32,19 @@ public function __construct()
     }
 
     /**
-     * Gets the 'service_from_anonymous_factory' service.
+     * Gets the public 'service_from_anonymous_factory' shared service.
      *
-     * This service is shared.
-     * This method always returns the same instance of the service.
-     *
-     * @return \Bar\FooClass A Bar\FooClass instance
+     * @return \Bar\FooClass
      */
     protected function getServiceFromAnonymousFactoryService()
     {
         return $this->services['service_from_anonymous_factory'] = call_user_func(array(new \Bar\FooClass(), 'getInstance'));
     }
 
     /**
-     * Gets the 'service_with_method_call_and_factory' service.
-     *
-     * This service is shared.
-     * This method always returns the same instance of the service.
+     * Gets the public 'service_with_method_call_and_factory' shared service.
      *
-     * @return \Bar\FooClass A Bar\FooClass instance
+     * @return \Bar\FooClass
      */
     protected function getServiceWithMethodCallAndFactoryService()
     {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services20.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services20.php
@@ -32,12 +32,9 @@ public function __construct()
     }
 
     /**
-     * Gets the 'depends_on_request' service.
+     * Gets the public 'depends_on_request' shared service.
      *
-     * This service is shared.
-     * This method always returns the same instance of the service.
-     *
-     * @return \stdClass A stdClass instance
+     * @return \stdClass
      */
     protected function getDependsOnRequestService()
     {
@@ -49,12 +46,9 @@ protected function getDependsOnRequestService()
     }
 
     /**
-     * Gets the 'request' service.
-     *
-     * This service is shared.
-     * This method always returns the same instance of the service.
+     * Gets the public 'request' shared service.
      *
-     * @return \Request A Request instance
+     * @return \Request
      */
     protected function getRequestService()
     {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9.php
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_compiled.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services9_compiled.php

Original file line number	Diff line number	Diff line change
`@@ -55,12 +55,9 @@ public function isFrozen()`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`/**`
`58`		`- * Gets the 'test' service.`
	`58`	`+ * Gets the public 'test' shared service.`
`59`	`59`	`*`
`60`		`- * This service is shared.`
`61`		`- * This method always returns the same instance of the service.`
`62`		`- *`
`63`		`- * @return \stdClass A stdClass instance`
	`60`	`+ * @return \stdClass`
`64`	`61`	`*/`
`65`	`62`	`protected function getTestService()`
`66`	`63`	`{`
Original file line number	Diff line number	Diff line change
`@@ -59,12 +59,9 @@ public function isFrozen()`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`/**`
`62`		`- * Gets the 'test' service.`
	`62`	`+ * Gets the public 'test' shared service.`
`63`	`63`	`*`
`64`		`- * This service is shared.`
`65`		`- * This method always returns the same instance of the service.`
`66`		`- *`
`67`		`- * @return \stdClass A stdClass instance`
	`64`	`+ * @return \stdClass`
`68`	`65`	`*/`
`69`	`66`	`protected function getTestService()`
`70`	`67`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,12 +53,9 @@ public function isFrozen()`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * Gets the 'bar' service.`
	`56`	`+ * Gets the public 'bar' shared service.`
`57`	`57`	`*`
`58`		`- * This service is shared.`
`59`		`- * This method always returns the same instance of the service.`
`60`		`- *`
`61`		`- * @return \stdClass A stdClass instance`
	`58`	`+ * @return \stdClass`
`62`	`59`	`*/`
`63`	`60`	`protected function getBarService()`
`64`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,25 +32,19 @@ public function __construct()`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
`35`		`- * Gets the 'service_from_anonymous_factory' service.`
	`35`	`+ * Gets the public 'service_from_anonymous_factory' shared service.`
`36`	`36`	`*`
`37`		`- * This service is shared.`
`38`		`- * This method always returns the same instance of the service.`
`39`		`- *`
`40`		`- * @return \Bar\FooClass A Bar\FooClass instance`
	`37`	`+ * @return \Bar\FooClass`
`41`	`38`	`*/`
`42`	`39`	`protected function getServiceFromAnonymousFactoryService()`
`43`	`40`	`{`
`44`	`41`	`return $this->services['service_from_anonymous_factory'] = call_user_func(array(new \Bar\FooClass(), 'getInstance'));`
`45`	`42`	`}`
`46`	`43`
`47`	`44`	`/**`
`48`		`- * Gets the 'service_with_method_call_and_factory' service.`
`49`		`- *`
`50`		`- * This service is shared.`
`51`		`- * This method always returns the same instance of the service.`
	`45`	`+ * Gets the public 'service_with_method_call_and_factory' shared service.`
`52`	`46`	`*`
`53`		`- * @return \Bar\FooClass A Bar\FooClass instance`
	`47`	`+ * @return \Bar\FooClass`
`54`	`48`	`*/`
`55`	`49`	`protected function getServiceWithMethodCallAndFactoryService()`
`56`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,12 +32,9 @@ public function __construct()`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
`35`		`- * Gets the 'depends_on_request' service.`
	`35`	`+ * Gets the public 'depends_on_request' shared service.`
`36`	`36`	`*`
`37`		`- * This service is shared.`
`38`		`- * This method always returns the same instance of the service.`
`39`		`- *`
`40`		`- * @return \stdClass A stdClass instance`
	`37`	`+ * @return \stdClass`
`41`	`38`	`*/`
`42`	`39`	`protected function getDependsOnRequestService()`
`43`	`40`	`{`
`@@ -49,12 +46,9 @@ protected function getDependsOnRequestService()`
`49`	`46`	`}`
`50`	`47`
`51`	`48`	`/**`
`52`		`- * Gets the 'request' service.`
`53`		`- *`
`54`		`- * This service is shared.`
`55`		`- * This method always returns the same instance of the service.`
	`49`	`+ * Gets the public 'request' shared service.`
`56`	`50`	`*`
`57`		`- * @return \Request A Request instance`
	`51`	`+ * @return \Request`
`58`	`52`	`*/`
`59`	`53`	`protected function getRequestService()`
`60`	`54`	`{`