minor #46496 [FrameworkBundle] update docblock to not expose the internal class (xabbuh)

nicolas-grekas · nicolas-grekas · commit fe1759af585d · 2022-05-30T13:51:52.000+02:00
This PR was merged into the 6.1 branch. Discussion ---------- [FrameworkBundle] update docblock to not expose the internal class | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #46483 | License | MIT | Doc PR | The change was introduced in #44695 motivated by the idea to be able to use the `getServiceIds()` and `getRemovedIds()` methods which are Symfony-specific methods. Exposing the `TestContainer` has the drawback of static analysis tools complaining about making use of internal classes. Since the interesting methods are part of the base `Container` class which is not internal I propose to change the docblock to return an instance of this class instead. Commits ------- f30db82 update docblock to not expose the internal class
diff --git a/.github/expected-missing-return-types.diff b/.github/expected-missing-return-types.diff
@@ -14,7 +14,7 @@ index d68ae4c8b3..8e980a9e70 100644
       * @return TestContainer
       */
 -    protected static function getContainer(): ContainerInterface
-+    protected static function getContainer(): TestContainer
++    protected static function getContainer(): Container
      {
          if (!static::$booted) {
 diff --git a/src/Symfony/Component/BrowserKit/AbstractBrowser.php b/src/Symfony/Component/BrowserKit/AbstractBrowser.php
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Test;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\HttpKernel\KernelInterface;
@@ -83,7 +84,7 @@ protected static function bootKernel(array $options = []): KernelInterface
      *
      * Using this method is the best way to get a container from your test code.
      *
-     * @return TestContainer
+     * @return Container
      */
     protected static function getContainer(): ContainerInterface
     {

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ index d68ae4c8b3..8e980a9e70 100644`
`14`	`14`	`* @return TestContainer`
`15`	`15`	`*/`
`16`	`16`	`- protected static function getContainer(): ContainerInterface`
`17`		`-+ protected static function getContainer(): TestContainer`
	`17`	`++ protected static function getContainer(): Container`
`18`	`18`	`{`
`19`	`19`	`if (!static::$booted) {`
`20`	`20`	`diff --git a/src/Symfony/Component/BrowserKit/AbstractBrowser.php b/src/Symfony/Component/BrowserKit/AbstractBrowser.php`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Bundle\FrameworkBundle\Test;`
`13`	`13`
`14`	`14`	`use PHPUnit\Framework\TestCase;`
	`15`	`+use Symfony\Component\DependencyInjection\Container;`
`15`	`16`	`use Symfony\Component\DependencyInjection\ContainerInterface;`
`16`	`17`	`use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;`
`17`	`18`	`use Symfony\Component\HttpKernel\KernelInterface;`
`@@ -83,7 +84,7 @@ protected static function bootKernel(array $options = []): KernelInterface`
`83`	`84`	`*`
`84`	`85`	`* Using this method is the best way to get a container from your test code.`
`85`	`86`	`*`
`86`		`- * @return TestContainer`
	`87`	`+ * @return Container`
`87`	`88`	`*/`
`88`	`89`	`protected static function getContainer(): ContainerInterface`
`89`	`90`	`{`