Add some return type hints [3.x] (#24)

Some of the type hints resolve deprecation notices emitted by Symfony, to prepare for adding type hints in future Symfony releases.
webfactory · May 5, 2022 · fc467c7 · fc467c7
1 parent 3858c53
commit fc467c7
Show file tree

Hide file tree

Showing 18 changed files with 107 additions and 127 deletions.
diff --git a/Build/BuildContext.php b/Build/BuildContext.php
@@ -25,20 +25,16 @@ public function __construct(array $params)
 
     /**
      * @param array<string, mixed> $params
-     *
-     * @return BuildContext
      */
-    public function change(array $params)
+    public function change(array $params): self
     {
         return new self(array_merge($this->params, $params));
     }
 
     /**
-     * @param string $name
-     *
      * @return mixed|null
      */
-    public function get($name)
+    public function get(string $name)
     {
         return isset($this->params[$name]) ? $this->params[$name] : null;
     }

diff --git a/Build/BuildDirector.php b/Build/BuildDirector.php
@@ -16,5 +16,8 @@
  */
 interface BuildDirector
 {
+    /**
+     * @return void
+     */
     public function build(BuildContext $c, Tree $t, BuildDispatcher $d);
 }
diff --git a/Build/BuildDispatcher.php b/Build/BuildDispatcher.php
@@ -17,12 +17,12 @@ class BuildDispatcher
     protected $resources = [];
     protected $queue;
 
-    public function addDirector(BuildDirector $director, $priority = 100)
+    public function addDirector(BuildDirector $director, $priority = 100): void
     {
         $this->directors[$priority][] = $director;
     }
 
-    public function start(Tree $tree)
+    public function start(Tree $tree): void
     {
         $directorsOrderedByPriority = $this->getDirectorsOrderedByPriority();
         $this->queue = [new BuildContext([])];
@@ -33,25 +33,25 @@ public function start(Tree $tree)
         }
     }
 
-    public function search(BuildContext $context)
+    public function search(BuildContext $context): void
     {
         $this->queue[] = $context;
     }
 
-    public function addResource(ResourceInterface $resource)
+    public function addResource(ResourceInterface $resource): void
     {
         $this->resources[] = $resource;
     }
 
-    public function getResources()
+    public function getResources(): array
     {
         return array_unique($this->resources);
     }
 
     /**
      * @return BuildDirector[]
      */
-    private function getDirectorsOrderedByPriority()
+    private function getDirectorsOrderedByPriority(): array
     {
         krsort($this->directors, SORT_NUMERIC);
         $buildDirectorsOrderedByPriority = [];

diff --git a/Build/TreeFactory.php b/Build/TreeFactory.php
@@ -41,7 +41,7 @@ class TreeFactory implements ServiceSubscriberInterface
     /** @var ContainerInterface */
     protected $container;
 
-    public static function getSubscribedServices()
+    public static function getSubscribedServices(): array
     {
         return [
             BuildDispatcher::class
@@ -64,19 +64,14 @@ public function __construct(
         $this->stopwatch = $stopwatch;
     }
 
-    public function debug($msg)
+    public function debug(string $msg): void
     {
         if ($this->logger) {
             $this->logger->debug("$msg (PID ".getmypid().', microtime '.microtime().')');
         }
     }
 
-    /**
-     * @param $sectionName
-     *
-     * @return StopwatchEvent|null
-     */
-    protected function startTiming($sectionName)
+    protected function startTiming(string $sectionName): ?StopwatchEvent
     {
         if ($this->stopwatch) {
             return $this->stopwatch->start('webfactory/navigation-bundle: '.$sectionName);
@@ -85,17 +80,14 @@ protected function startTiming($sectionName)
         return null;
     }
 
-    protected function stopTiming(StopwatchEvent $watch = null)
+    protected function stopTiming(StopwatchEvent $watch = null): void
     {
         if ($watch) {
             $watch->stop();
         }
     }
 
-    /**
-     * @return Tree
-     */
-    public function getTree()
+    public function getTree(): Tree
     {
         if (!$this->_tree) {
             $self = $this;
@@ -124,7 +116,7 @@ public function getTree()
         return $this->_tree;
     }
 
-    public function buildTreeCache(ConfigCacheInterface $cache)
+    public function buildTreeCache(ConfigCacheInterface $cache): void
     {
         $this->_tree = new Tree();
         // Dynamic (runtime) lookup:

diff --git a/Command/DumpTreeCommand.php b/Command/DumpTreeCommand.php
@@ -32,7 +32,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         return 0;
     }
 
-    private function dumpNode(Node $n, OutputInterface $output, $depth = 0)
+    private function dumpNode(Node $n, OutputInterface $output, $depth = 0): void
     {
         $first = true;
 

diff --git a/Controller/NavigationController.php b/Controller/NavigationController.php
@@ -15,7 +15,7 @@
 
 class NavigationController extends AbstractController
 {
-    public static function getSubscribedServices()
+    public static function getSubscribedServices(): array
     {
         return array_merge(parent::getSubscribedServices(), [
             Tree::class,
@@ -39,7 +39,8 @@ public function treeAction(
         $maxLevels = 1,
         $expandedLevels = 1,
         $template = '@WebfactoryNavigation/Navigation/navigation.html.twig'
-    ) {
+    ): Response
+    {
         if (\is_array($root)) {
             $node = $this->getTree()->find($root);
             if (!$node) {
@@ -81,7 +82,7 @@ public function treeAction(
      *
      * @return Response
      */
-    public function ancestryAction($startLevel, $maxLevels = 1, $expandedLevels = 1, $template = '@WebfactoryNavigation/Navigation/navigation.html.twig')
+    public function ancestryAction($startLevel, $maxLevels = 1, $expandedLevels = 1, $template = '@WebfactoryNavigation/Navigation/navigation.html.twig'): Response
     {
         if ($node = $this->getTree()->getActivePath()) {
             $path = $node->getPath();
@@ -101,7 +102,7 @@ public function ancestryAction($startLevel, $maxLevels = 1, $expandedLevels = 1,
      *
      * @return Response
      */
-    public function breadcrumbsAction($template = '@WebfactoryNavigation/Navigation/breadcrumbs.html.twig')
+    public function breadcrumbsAction($template = '@WebfactoryNavigation/Navigation/breadcrumbs.html.twig'): Response
     {
         if ($node = $this->getTree()->getActivePath()) {
             return $this->render($template, [

diff --git a/DependencyInjection/Compiler/BuildDirectorPass.php b/DependencyInjection/Compiler/BuildDirectorPass.php
@@ -15,7 +15,7 @@
 
 class BuildDirectorPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition(BuildDispatcher::class)) {
             return;

diff --git a/DependencyInjection/WebfactoryNavigationExtension.php b/DependencyInjection/WebfactoryNavigationExtension.php
@@ -15,7 +15,7 @@
 
 class WebfactoryNavigationExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');

diff --git a/Event/ActiveNodeEventListener.php b/Event/ActiveNodeEventListener.php
@@ -20,7 +20,7 @@ public function __construct(RequestStack $requestStack)
         $this->requestStack = $requestStack;
     }
 
-    public function initializeTree(TreeInitializedEvent $event)
+    public function initializeTree(TreeInitializedEvent $event): void
     {
         if ($masterRequest = $this->requestStack->getMasterRequest()) {
             if ($node = $event->getTree()->find($masterRequest->attributes->all())) {

diff --git a/Event/TreeInitializedEvent.php b/Event/TreeInitializedEvent.php
@@ -21,10 +21,7 @@ public function __construct(Tree $tree)
         $this->tree = $tree;
     }
 
-    /**
-     * @return Tree
-     */
-    public function getTree()
+    public function getTree(): Tree
     {
         return $this->tree;
     }

diff --git a/Tree/Finder.php b/Tree/Finder.php
@@ -22,11 +22,7 @@ class Finder
     /** @var string[] */
     protected $idToHash = [];
 
-    /**
-     * @param Node  $object
-     * @param array $requirements
-     */
-    public function add($object, array $requirements)
+    public function add(Node $object, array $requirements): void
     {
         $hash = spl_object_hash($object);
         $this->objects[$hash] = $object;
@@ -48,10 +44,8 @@ public function add($object, array $requirements)
 
     /**
      * @param string|array|object $provided
-     *
-     * @return Node|null
      */
-    public function lookup($provided)
+    public function lookup($provided): ?Node
     {
         $remainingCount = [];
         $maxMatch = 0;