Use more type hints

Use return types, remove docblocks without remaining value.

Author: MalteWunsch

Tests/DependencyInjection/Compiler/ShortcodeCompilerPassTest.php

@@ -22,7 +22,7 @@ final class ShortcodeCompilerPassTest extends TestCase
     /** @var ContainerBuilder|\PHPUnit_Framework_MockObject_MockObject */
     private $containerBuilder;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->compilerPass = new ShortcodeCompilerPass();
         $this->containerBuilder = $this->getMockBuilder(ContainerBuilder::class)
@@ -31,7 +31,7 @@ protected function setUp()
     }
 
     /** @test */
-    public function tagged_services_are_added_as_handlers_to_handler_container()
+    public function tagged_services_are_added_as_handlers_to_handler_container(): void
     {
         $this->containerBuilder->expects($this->once())
             ->method('findTaggedServiceIds')
@@ -66,10 +66,8 @@ public function tagged_services_are_added_as_handlers_to_handler_container()
         $this->compilerPass->process($this->containerBuilder);
     }
 
-    /**
-     * @test
-     */
-    public function no_tagged_services_do_no_harm()
+    /** @test */
+    public function no_tagged_services_do_no_harm(): void
     {
         $this->containerBuilder->expects($this->once())
             ->method('findTaggedServiceIds')
@@ -79,7 +77,7 @@ public function no_tagged_services_do_no_harm()
     }
 
     /** @test */
-    public function shortcode_guide_service_gets_configured_if_set()
+    public function shortcode_guide_service_gets_configured_if_set(): void
     {
         $this->containerBuilder->expects($this->once())
             ->method('findTaggedServiceIds')
@@ -121,10 +119,8 @@ public function shortcode_guide_service_gets_configured_if_set()
         $this->compilerPass->process($this->containerBuilder);
     }
 
-    /**
-     * @test
-     */
-    public function missing_shortcode_guide_service_does_no_harm()
+    /** @test */
+    public function missing_shortcode_guide_service_does_no_harm(): void
     {
         $this->containerBuilder->expects($this->once())
             ->method('findTaggedServiceIds')

Tests/Fixtures/PublicFragmentHandlerClass.php

@@ -10,7 +10,7 @@
  */
 class PublicFragmentHandlerClass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $container->getDefinition('fragment.handler')->setPublic(true);
     }

Tests/Fixtures/TestKernel.php

@@ -20,11 +20,9 @@ final class TestKernel extends Kernel
     use MicroKernelTrait;
 
     /**
-     * Returns an array of bundles to register.
-     *
      * @return BundleInterface[] An array of bundle instances
      */
-    public function registerBundles()
+    public function registerBundles(): array
     {
         return [
             new FrameworkBundle(),
@@ -33,29 +31,19 @@ public function registerBundles()
         ];
     }
 
-    protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader)
+    protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader): void
     {
         $loader->load(__DIR__.'/config/config.yml');
         $loader->load(__DIR__.'/config/test_shortcodes.xml');
         $container->addCompilerPass(new PublicFragmentHandlerClass());
     }
 
-    /**
-     * Gets the cache directory.
-     *
-     * @return string The cache directory
-     */
-    public function getCacheDir()
+    public function getCacheDir(): string
     {
         return __DIR__.'/cache/'.$this->environment;
     }
 
-    /**
-     * Gets the log directory.
-     *
-     * @return string The log directory
-     */
-    public function getLogDir()
+    public function getLogDir(): string
     {
         return __DIR__.'/logs';
     }
@@ -68,7 +56,7 @@ public function getLogDir()
      *
      * @param RouteCollectionBuilder $routes
      */
-    protected function configureRoutes(RouteCollectionBuilder $routes)
+    protected function configureRoutes(RouteCollectionBuilder $routes): void
     {
     }
 }

Tests/Functional/ShortcodeFacadeTest.php

@@ -4,19 +4,20 @@
 
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
 use Symfony\Component\HttpKernel\Fragment\FragmentHandler;
 
 final class ShortcodeFacadeTest extends KernelTestCase
 {
     private $fragmentHandler;
 
-    protected static function getKernelClass()
+    protected static function getKernelClass(): string
     {
         return 'Webfactory\ShortcodeBundle\Tests\Fixtures\TestKernel';
     }
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
         static::bootKernel();
@@ -46,7 +47,7 @@ public function processes_shortcodes(string $shortcode, ControllerReference $con
         );
     }
 
-    public function shortcodeFixtures()
+    public function shortcodeFixtures(): array
     {
         return [
             ['[test-esi foo=bar]', new ControllerReference('test-esi-controller', ['foo' => 'bar']), 'esi'],
@@ -55,7 +56,7 @@ public function shortcodeFixtures()
     }
 
     /** @test */
-    public function paragraphs_wrapping_shortcodes_get_removed()
+    public function paragraphs_wrapping_shortcodes_get_removed(): void
     {
         $this->fragmentHandler->method('render')->willReturn('RESULT');
 
@@ -66,21 +67,15 @@ public function paragraphs_wrapping_shortcodes_get_removed()
     }
 
     /** @test */
-    public function content_without_shortcodes_wont_be_changed()
+    public function content_without_shortcodes_wont_be_changed(): void
     {
         $this->assertEquals(
             '<p>Content without shortcode</p>',
             $this->renderTwigTemplate("{{ '<p>Content without shortcode</p>' | shortcodes }}")
         );
     }
 
-    /**
-     * @param string $templateCode
-     * @param array  $context
-     *
-     * @return string
-     */
-    private function renderTwigTemplate($templateCode, array $context = [])
+    private function renderTwigTemplate(string $templateCode, array $context = []): string
     {
         /** @var $container ContainerInterface */
         $container = static::$kernel->getContainer();

Tests/Functional/ShortcodeTest.php

@@ -13,9 +13,9 @@ abstract class ShortcodeTest extends WebTestCase
     /**
      * @return string name of the shortcode to test.
      */
-    abstract protected function getShortcodeToTest();
+    abstract protected function getShortcodeToTest(): string;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();
 
@@ -26,12 +26,7 @@ protected function setUp()
         }
     }
 
-    /**
-     * @param string|null $customParameters
-     *
-     * @return Crawler
-     */
-    protected function crawlRenderedExample($customParameters = null)
+    protected function crawlRenderedExample(string $customParameters = null): Crawler
     {
         $urlWithRenderedExample = $this->getUrlWithRenderedExample($customParameters);
 
@@ -49,13 +44,7 @@ protected function crawlRenderedExample($customParameters = null)
         return $crawlerOnRenderedExample;
     }
 
-    /**
-     * @param int         $expectedStatusCode
-     * @param string|null $customParameters
-     *
-     * @return Crawler
-     */
-    protected function assertHttpStatusCodeWhenCrawlingRenderedExample($expectedStatusCode, $customParameters = null)
+    protected function assertHttpStatusCodeWhenCrawlingRenderedExample(int $expectedStatusCode, string $customParameters = null): Crawler
     {
         $urlWithRenderedExample = $this->getUrlWithRenderedExample($customParameters);
 
@@ -64,12 +53,7 @@ protected function assertHttpStatusCodeWhenCrawlingRenderedExample($expectedStat
         $this->assertEquals($expectedStatusCode, $client->getResponse()->getStatusCode());
     }
 
-    /**
-     * @param string|null $customParameters
-     *
-     * @return string
-     */
-    protected function getUrlWithRenderedExample($customParameters = null)
+    protected function getUrlWithRenderedExample(string $customParameters = null): string
     {
         static::bootKernel();