return types on DI code

Author: dbu

src/DependencyInjection/Configuration.php

@@ -190,7 +190,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $treeBuilder;
     }
 
-    private function configureClients(ArrayNodeDefinition $root)
+    private function configureClients(ArrayNodeDefinition $root): void
     {
         $root->children()
             ->arrayNode('clients')
@@ -249,7 +249,7 @@ private function configureClients(ArrayNodeDefinition $root)
         ->end();
     }
 
-    private function configureSharedPlugins(ArrayNodeDefinition $root)
+    private function configureSharedPlugins(ArrayNodeDefinition $root): void
     {
         $pluginsNode = $root
             ->children()
@@ -262,11 +262,9 @@ private function configureSharedPlugins(ArrayNodeDefinition $root)
     }
 
     /**
-     * Createplugins node of a client.
-     *
-     * @return ArrayNodeDefinition The plugin node
+     * Create plugins node of a client.
      */
-    private function createClientPluginNode()
+    private function createClientPluginNode(): ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('plugins');
         $node = $treeBuilder->getRootNode();
@@ -527,7 +525,7 @@ private function createClientPluginNode()
      * @param ArrayNodeDefinition $pluginNode the node to add to
      * @param bool                $disableAll Some shared plugins are enabled by default. On the client, all are disabled by default.
      */
-    private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableAll = false)
+    private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableAll = false): void
     {
         $children = $pluginNode->children();
 
@@ -633,7 +631,7 @@ private function addSharedPluginNodes(ArrayNodeDefinition $pluginNode, $disableA
      *
      * @return NodeDefinition definition for the authentication node in the plugins list
      */
-    private function createAuthenticationPluginNode()
+    private function createAuthenticationPluginNode(): NodeDefinition
     {
         $treeBuilder = new TreeBuilder('authentication');
         $node = $treeBuilder->getRootNode();
@@ -697,7 +695,7 @@ private function createAuthenticationPluginNode()
      *
      * @throws InvalidConfigurationException If $actual does not have exactly the keys specified in $expected (plus 'type')
      */
-    private function validateAuthenticationType(array $expected, array $actual, $authName)
+    private function validateAuthenticationType(array $expected, array $actual, $authName): void
     {
         unset($actual['type']);
         // Empty array is always provided, even if the config is not filled.
@@ -725,7 +723,7 @@ private function validateAuthenticationType(array $expected, array $actual, $aut
      *
      * @return NodeDefinition definition for the cache node in the plugins list
      */
-    private function createCachePluginNode()
+    private function createCachePluginNode(): NodeDefinition
     {
         $builder = new TreeBuilder('config');
         $config = $builder->getRootNode();

src/DependencyInjection/HttplugExtension.php

@@ -24,6 +24,7 @@
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\UriInterface;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\ChildDefinition;
@@ -50,10 +51,7 @@ class HttplugExtension extends Extension
      */
     private $useVcrPlugin = false;
 
-    /**
-     * {@inheritdoc}
-     */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = $this->getConfiguration($configs, $container);
         $config = $this->processConfiguration($configuration, $configs);
@@ -122,7 +120,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         if ($this->useVcrPlugin) {
             if (!\class_exists(RecordPlugin::class)) {
-                throw new \Exception('You need to require the VCR plugin to be able to use it: "composer require --dev php-http/vcr-plugin".');
+                throw new InvalidConfigurationException('You need to require the VCR plugin to be able to use it: "composer require --dev php-http/vcr-plugin".');
             }
 
             $loader->load('vcr-plugin.xml');
@@ -132,7 +130,7 @@ public function load(array $configs, ContainerBuilder $container)
     /**
      * Configure client services.
      */
-    private function configureClients(ContainerBuilder $container, array $config)
+    private function configureClients(ContainerBuilder $container, array $config): void
     {
         $first = null;
         $clients = [];
@@ -182,7 +180,7 @@ private function configureClients(ContainerBuilder $container, array $config)
     /**
      * Configure all Httplug plugins or remove their service definition.
      */
-    private function configurePlugins(ContainerBuilder $container, array $config)
+    private function configurePlugins(ContainerBuilder $container, array $config): void
     {
         if (!empty($config['authentication'])) {
             $this->configureAuthentication($container, $config['authentication']);
@@ -204,7 +202,7 @@ private function configurePlugins(ContainerBuilder $container, array $config)
      * @param ContainerBuilder $container In case we need to add additional services for this plugin
      * @param string           $serviceId service id of the plugin, in case we need to add additional services for this plugin
      */
-    private function configurePluginByName($name, Definition $definition, array $config, ContainerBuilder $container, $serviceId)
+    private function configurePluginByName($name, Definition $definition, array $config, ContainerBuilder $container, $serviceId): void
     {
         switch ($name) {
             case 'cache':
@@ -352,9 +350,9 @@ private function configurePluginByName($name, Definition $definition, array $con
     }
 
     /**
-     * @return array list of service ids for the authentication plugins
+     * @return string[] list of service ids for the authentication plugins
      */
-    private function configureAuthentication(ContainerBuilder $container, array $config, $servicePrefix = 'httplug.plugin.authentication')
+    private function configureAuthentication(ContainerBuilder $container, array $config, $servicePrefix = 'httplug.plugin.authentication'): array
     {
         $pluginServices = [];
 
@@ -404,7 +402,7 @@ private function configureAuthentication(ContainerBuilder $container, array $con
     /**
      * @param string $clientName
      */
-    private function configureClient(ContainerBuilder $container, $clientName, array $arguments)
+    private function configureClient(ContainerBuilder $container, $clientName, array $arguments): void
     {
         $serviceId = 'httplug.client.'.$clientName;
 
@@ -502,7 +500,7 @@ function ($id) {
      * @param string $serviceId Name of the private service to create
      * @param string $uri       String representation of the URI
      */
-    private function createUri(ContainerBuilder $container, $serviceId, $uri)
+    private function createUri(ContainerBuilder $container, $serviceId, $uri): void
     {
         $container
             ->register($serviceId, UriInterface::class)
@@ -516,7 +514,7 @@ private function createUri(ContainerBuilder $container, $serviceId, $uri)
      * Make the user can select what client is used for auto discovery. If none is provided, a service will be created
      * by finding a client using auto discovery.
      */
-    private function configureAutoDiscoveryClients(ContainerBuilder $container, array $config)
+    private function configureAutoDiscoveryClients(ContainerBuilder $container, array $config): void
     {
         $httpClient = $config['discovery']['client'];
         if ('auto' !== $httpClient) {
@@ -563,7 +561,7 @@ public function getConfiguration(array $config, ContainerBuilder $container): ?C
      *
      * @return string configured service id
      */
-    private function configurePlugin(ContainerBuilder $container, $serviceId, $pluginName, array $pluginConfig)
+    private function configurePlugin(ContainerBuilder $container, $serviceId, $pluginName, array $pluginConfig): string
     {
         $pluginServiceId = $serviceId.'.plugin.'.$pluginName;
 
@@ -575,7 +573,7 @@ private function configurePlugin(ContainerBuilder $container, $serviceId, $plugi
         return $pluginServiceId;
     }
 
-    private function configureVcrPlugin(ContainerBuilder $container, array $config, $prefix)
+    private function configureVcrPlugin(ContainerBuilder $container, array $config, $prefix): array
     {
         $recorder = $config['recorder'];
         $recorderId = in_array($recorder, ['filesystem', 'in_memory']) ? 'httplug.plugin.vcr.recorder.'.$recorder : $recorder;