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

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

Author: fabpot

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)

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()
  {

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()
  {

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()
  {

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()
  {

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()
  {