Issue #4: Fix missing return types that cause warnings with Symfony 5.4 (#5)

Author: asprega

composer.json

@@ -24,6 +24,7 @@
         "symfony/framework-bundle": "^4.0|^5.0",
         "symfony/property-access": "^4.0|^5.0",
         "symfony/translation-contracts": "^1.0|^2.0",
+        "symfony/yaml": "^4.0|^5.0",
         "twig/twig": "^2.10|^3.0"
     },
     "require-dev": {

src/DependencyInjection/Configuration.php

@@ -10,7 +10,7 @@ class Configuration implements ConfigurationInterface
     /**
      * {@inheritdoc}
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $builder = new TreeBuilder('slope_it_breadcrumb');
         $builder->getRootNode()

src/DependencyInjection/SlopeItBreadcrumbExtension.php

@@ -12,15 +12,15 @@ class SlopeItBreadcrumbExtension extends Extension
     /**
      * {@inheritdoc}
      */
-    public function getAlias()
+    public function getAlias(): string
     {
         return 'slope_it_breadcrumb';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yml');

src/EventListener/BreadcrumbListener.php

@@ -25,7 +25,7 @@ public function __construct(BreadcrumbBuilder $breadcrumbBuilder, Reader $annota
         $this->annotationReader = $annotationReader;
     }
 
-    public function onKernelController(ControllerEvent $event)
+    public function onKernelController(ControllerEvent $event): void
     {
         // In case controller is not an array (e.g. a closure or an invokable class), we can't do anything.
         if (!is_array($event->getController())) {

src/Service/BreadcrumbItemProcessor.php

@@ -47,6 +47,9 @@ public function __construct(
         $this->requestStack = $requestStack;
     }
 
+    /**
+     * @param array<string, mixed> $variables
+     */
     public function process(BreadcrumbItem $item, array $variables): ProcessedBreadcrumbItem
     {
         // Process the label
@@ -85,6 +88,8 @@ public function process(BreadcrumbItem $item, array $variables): ProcessedBreadc
 
     /**
      * Returns the value contained in the variable name (with optional property path) of the given expression.
+     *
+     * @return mixed
      */
     private function parseValue(string $expression, array $variables)
     {

src/SlopeItBreadcrumbBundle.php

@@ -3,14 +3,15 @@
 namespace SlopeIt\BreadcrumbBundle;
 
 use SlopeIt\BreadcrumbBundle\DependencyInjection\SlopeItBreadcrumbExtension;
+use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 class SlopeItBreadcrumbBundle extends Bundle
 {
     /**
      * {@inheritdoc}
      */
-    public function getContainerExtension()
+    public function getContainerExtension(): ?ExtensionInterface
     {
         return new SlopeItBreadcrumbExtension();
     }

src/Twig/BreadcrumbExtension.php

@@ -25,12 +25,7 @@ class BreadcrumbExtension extends AbstractExtension
      */
     private $template;
 
-    /**
-     * @param BreadcrumbBuilder       $builder
-     * @param BreadcrumbItemProcessor $itemProcessor
-     * @param string                  $template
-     */
-    public function __construct(BreadcrumbBuilder $builder, BreadcrumbItemProcessor $itemProcessor, $template)
+    public function __construct(BreadcrumbBuilder $builder, BreadcrumbItemProcessor $itemProcessor, string $template)
     {
         $this->builder = $builder;
         $this->itemProcessor = $itemProcessor;
@@ -39,8 +34,9 @@ public function __construct(BreadcrumbBuilder $builder, BreadcrumbItemProcessor
 
     /**
      * {@inheritDoc}
+     * @return TwigFunction[]
      */
-    public function getFunctions()
+    public function getFunctions(): array
     {
         return [
             new TwigFunction(
@@ -55,20 +51,12 @@ public function getFunctions()
         ];
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getName()
+    public function getName(): string
     {
         return 'slope_it_breadcrumb';
     }
 
-    /**
-     * Returns the rendered breadcrumb.
-     *
-     * @return string
-     */
-    public function renderBreadcrumb(Environment $twig, array $context)
+    public function renderBreadcrumb(Environment $twig, array $context): string
     {
         $breadcrumb = [];
         foreach ($this->builder->getItems() as $item) {

tests/DependencyInjection/SlopeItBreadcrumbExtensionTest.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace SlopeIt\Tests\BreadcrumbBundle\DependencyInjection;
+
+use PHPUnit\Framework\TestCase;
+use SlopeIt\BreadcrumbBundle\DependencyInjection\SlopeItBreadcrumbExtension;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class SlopeItBreadcrumbExtensionTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function its_template_can_be_overridden_via_configuration()
+    {
+        $container = new ContainerBuilder();
+
+        $extension = new SlopeItBreadcrumbExtension();
+        $config = [
+            'template' => 'some-template.html.twig',
+        ];
+
+        $extension->load([$config], $container);
+
+        $this->assertSame('some-template.html.twig', $container->getParameter('slope_it_breadcrumb.template'));
+    }
+}