minor #2125 add type declarations (xabbuh)

This PR was merged into the 3.0-dev branch. Discussion ---------- add type declarations Commits ------- d71f1fc add type declarations where possible
FriendsOfSymfony · Mar 18, 2020 · fc2666e · fc2666e
2 parents 991fcca + d71f1fc
commit fc2666e
Show file tree

Hide file tree

Showing 75 changed files with 276 additions and 629 deletions.
diff --git a/Context/Context.php b/Context/Context.php
@@ -23,7 +23,6 @@ final class Context
     private $attributes = array();
     private $version;
     private $groups;
-    private $maxDepth;
     private $isMaxDepthEnabled;
     private $serializeNull;
 
@@ -56,20 +55,14 @@ public function getAttributes(): array
         return $this->attributes;
     }
 
-    /**
-     * Sets the normalization version.
-     */
     public function setVersion(string $version): self
     {
         $this->version = $version;
 
         return $this;
     }
 
-    /**
-     * @return string|int|null
-     */
-    public function getVersion()
+    public function getVersion(): ?string
     {
         return $this->version;
     }
@@ -125,7 +118,7 @@ public function setGroups(array $groups = null): self
         return $this;
     }
 
-    public function enableMaxDepth()
+    public function enableMaxDepth(): self
     {
         $this->isMaxDepthEnabled = true;
 
@@ -173,7 +166,7 @@ public function getExclusionStrategies(): array
      *
      * Notice: This method only applies to the JMS serializer adapter.
      */
-    public function addExclusionStrategy(ExclusionStrategyInterface $exclusionStrategy)
+    public function addExclusionStrategy(ExclusionStrategyInterface $exclusionStrategy): void
     {
         $this->exclusionStrategies[] = $exclusionStrategy;
     }

diff --git a/Controller/ControllerTrait.php b/Controller/ControllerTrait.php
@@ -40,33 +40,25 @@ protected function getViewHandler()
     }
 
     /**
-     * @param int $statusCode
-     *
      * @return View
      */
-    protected function view($data = null, $statusCode = null, array $headers = [])
+    protected function view($data = null, ?int $statusCode = null, array $headers = [])
     {
         return View::create($data, $statusCode, $headers);
     }
 
     /**
-     * @param string $url
-     * @param int    $statusCode
-     *
      * @return View
      */
-    protected function redirectView($url, $statusCode = Response::HTTP_FOUND, array $headers = [])
+    protected function redirectView(string $url, int $statusCode = Response::HTTP_FOUND, array $headers = [])
     {
         return View::createRedirect($url, $statusCode, $headers);
     }
 
     /**
-     * @param string $route
-     * @param int    $statusCode
-     *
      * @return View
      */
-    protected function routeRedirectView($route, array $parameters = [], $statusCode = Response::HTTP_CREATED, array $headers = [])
+    protected function routeRedirectView(string $route, array $parameters = [], int $statusCode = Response::HTTP_CREATED, array $headers = [])
     {
         return View::createRouteRedirect($route, $parameters, $statusCode, $headers);
     }

diff --git a/Controller/ExceptionController.php b/Controller/ExceptionController.php
@@ -17,7 +17,6 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
-use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
 
 /**
  * Custom ExceptionController that uses the view layer and supports HTTP response status code mapping.
@@ -38,12 +37,9 @@ public function __construct(
         $this->showException = $showException;
     }
 
-    /**
-     * @param \Throwable $exception
-     */
-    public function showAction(Request $request, $exception, DebugLoggerInterface $logger = null)
+    public function showAction(Request $request, \Throwable $exception): Response
     {
-        $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
+        $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
 
         $view = new View($exception, $this->getStatusCode($exception), $exception instanceof HttpExceptionInterface ? $exception->getHeaders() : []);
 

diff --git a/Decoder/ContainerDecoderProvider.php b/Decoder/ContainerDecoderProvider.php
@@ -35,15 +35,15 @@ public function __construct(ContainerInterface $container, array $decoders)
     /**
      * {@inheritdoc}
      */
-    public function supports($format)
+    public function supports(string $format): bool
     {
         return isset($this->decoders[$format]);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getDecoder($format)
+    public function getDecoder(string $format): DecoderInterface
     {
         if (!$this->supports($format)) {
             throw new \InvalidArgumentException(sprintf("Format '%s' is not supported by ContainerDecoderProvider.", $format));

diff --git a/Decoder/DecoderInterface.php b/Decoder/DecoderInterface.php
@@ -21,9 +21,7 @@ interface DecoderInterface
     /**
      * Decodes a string into PHP data.
      *
-     * @param string $data
-     *
      * @return mixed False in case the content could not be decoded
      */
-    public function decode($data);
+    public function decode(string $data);
 }
diff --git a/Decoder/DecoderProviderInterface.php b/Decoder/DecoderProviderInterface.php
@@ -21,18 +21,14 @@ interface DecoderProviderInterface
     /**
      * Checks if a certain format is supported.
      *
-     * @param string $format
-     *
      * @return bool
      */
-    public function supports($format);
+    public function supports(string $format);
 
     /**
      * Provides decoders, possibly lazily.
      *
-     * @param string $format
-     *
      * @return DecoderInterface
      */
-    public function getDecoder($format);
+    public function getDecoder(string $format);
 }
diff --git a/Decoder/JsonDecoder.php b/Decoder/JsonDecoder.php
@@ -21,7 +21,7 @@ final class JsonDecoder implements DecoderInterface
     /**
      * {@inheritdoc}
      */
-    public function decode($data)
+    public function decode(string $data)
     {
         return @json_decode($data, true);
     }

diff --git a/Decoder/JsonToFormDecoder.php b/Decoder/JsonToFormDecoder.php
@@ -21,7 +21,7 @@ final class JsonToFormDecoder implements DecoderInterface
     /**
      * Makes data decoded from JSON application/x-www-form-encoded compliant.
      */
-    private function xWwwFormEncodedLike(array &$data)
+    private function xWwwFormEncodedLike(array &$data): void
     {
         foreach ($data as $key => &$value) {
             if (is_array($value)) {
@@ -43,7 +43,7 @@ private function xWwwFormEncodedLike(array &$data)
     /**
      * {@inheritdoc}
      */
-    public function decode($data)
+    public function decode(string $data)
     {
         $decodedData = @json_decode($data, true);
         if ($decodedData) {

diff --git a/Decoder/XmlDecoder.php b/Decoder/XmlDecoder.php
@@ -33,7 +33,7 @@ public function __construct()
     /**
      * {@inheritdoc}
      */
-    public function decode($data)
+    public function decode(string $data)
     {
         try {
             return $this->encoder->decode($data, 'xml');

diff --git a/DependencyInjection/Compiler/ConfigurationCheckPass.php b/DependencyInjection/Compiler/ConfigurationCheckPass.php
@@ -25,7 +25,7 @@
  */
 final class ConfigurationCheckPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if ($container->has('fos_rest.converter.request_body') && !($container->has('sensio_framework_extra.converter.listener') || $container->has(ParamConverterListener::class))) {
             throw new \RuntimeException('You need to enable the parameter converter listeners in SensioFrameworkExtraBundle when using the FOSRestBundle RequestBodyParamConverter');

diff --git a/DependencyInjection/Compiler/FormatListenerRulesPass.php b/DependencyInjection/Compiler/FormatListenerRulesPass.php
@@ -24,7 +24,7 @@
  */
 final class FormatListenerRulesPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('fos_rest.format_listener')) {
             return;
@@ -57,7 +57,7 @@ public function process(ContainerBuilder $container)
         $container->setParameter('fos_rest.format_listener.rules', null);
     }
 
-    private function addRule(array $rule, ContainerBuilder $container)
+    private function addRule(array $rule, ContainerBuilder $container): void
     {
         $matcher = $this->createRequestMatcher(
             $container,
@@ -76,7 +76,7 @@ private function addRule(array $rule, ContainerBuilder $container)
             ->addMethodCall('add', [$matcher, $rule]);
     }
 
-    private function createRequestMatcher(ContainerBuilder $container, $path = null, $host = null, $methods = null, array $attributes = array())
+    private function createRequestMatcher(ContainerBuilder $container, ?string $path = null, ?string $host = null, ?array $methods = null, array $attributes = array()): Reference
     {
         $arguments = [$path, $host, $methods, null, $attributes];
         $serialized = serialize($arguments);

diff --git a/DependencyInjection/Compiler/HandlerRegistryDecorationPass.php b/DependencyInjection/Compiler/HandlerRegistryDecorationPass.php
@@ -31,7 +31,7 @@
  */
 class HandlerRegistryDecorationPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has('fos_rest.serializer.jms_handler_registry')) {
             return;

diff --git a/DependencyInjection/Compiler/JMSFormErrorHandlerPass.php b/DependencyInjection/Compiler/JMSFormErrorHandlerPass.php
@@ -26,7 +26,7 @@
  */
 final class JMSFormErrorHandlerPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has('jms_serializer.form_error_handler')) {
             return;

diff --git a/DependencyInjection/Compiler/JMSHandlersPass.php b/DependencyInjection/Compiler/JMSHandlersPass.php
@@ -24,7 +24,7 @@
  */
 final class JMSHandlersPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if ($container->has('jms_serializer.handler_registry')) {
             // the public alias prevents the handler registry definition from being removed

diff --git a/DependencyInjection/Compiler/SerializerConfigurationPass.php b/DependencyInjection/Compiler/SerializerConfigurationPass.php
@@ -26,7 +26,7 @@
  */
 final class SerializerConfigurationPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if ($container->has('fos_rest.serializer')) {
             $class = $container->getParameterBag()->resolveValue(

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -31,11 +31,6 @@
  */
 final class Configuration implements ConfigurationInterface
 {
-    /**
-     * Default debug mode value.
-     *
-     * @var bool
-     */
     private $debug;
 
     public function __construct(bool $debug)
@@ -188,7 +183,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $treeBuilder;
     }
 
-    private function addViewSection(ArrayNodeDefinition $rootNode)
+    private function addViewSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -274,7 +269,7 @@ private function addViewSection(ArrayNodeDefinition $rootNode)
             ->end();
     }
 
-    private function addBodyListenerSection(ArrayNodeDefinition $rootNode)
+    private function addBodyListenerSection(ArrayNodeDefinition $rootNode): void
     {
         $decodersDefaultValue = ['json' => 'fos_rest.decoder.json'];
         if (class_exists(XmlEncoder::class)) {
@@ -315,7 +310,7 @@ private function addBodyListenerSection(ArrayNodeDefinition $rootNode)
             ->end();
     }
 
-    private function addFormatListenerSection(ArrayNodeDefinition $rootNode)
+    private function addFormatListenerSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -369,7 +364,7 @@ private function addFormatListenerSection(ArrayNodeDefinition $rootNode)
             ->end();
     }
 
-    private function addVersioningSection(ArrayNodeDefinition $rootNode)
+    private function addVersioningSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
         ->children()
@@ -419,7 +414,7 @@ private function addVersioningSection(ArrayNodeDefinition $rootNode)
         ->end();
     }
 
-    private function addExceptionSection(ArrayNodeDefinition $rootNode)
+    private function addExceptionSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
             ->children()
@@ -486,7 +481,7 @@ private function addExceptionSection(ArrayNodeDefinition $rootNode)
             ->end();
     }
 
-    private function testExceptionExists(string $exception)
+    private function testExceptionExists(string $exception): void
     {
         if (!is_subclass_of($exception, \Exception::class) && !is_a($exception, \Exception::class, true)) {
             throw new InvalidConfigurationException(sprintf('FOSRestBundle exception mapper: Could not load class "%s" or the class does not extend from "%s". Most probably this is a configuration problem.', $exception, \Exception::class));