[VarDumper] Add missing return types

symfony · Apr 14, 2023 · 5767c81 · 5767c81
1 parent cb21bc9
commit 5767c81
Show file tree

Hide file tree

Showing 13 changed files with 61 additions and 10 deletions.
diff --git a/Caster/ClassStub.php b/Caster/ClassStub.php
@@ -85,6 +85,9 @@ public function __construct(string $identifier, callable|array|string $callable
         }
     }
 
+    /**
+     * @return mixed
+     */
     public static function wrapCallable(mixed $callable)
     {
         if (\is_object($callable) || !\is_callable($callable)) {

diff --git a/Caster/ExceptionCaster.php b/Caster/ExceptionCaster.php
@@ -289,6 +289,9 @@ public static function castFrameStub(FrameStub $frame, array $a, Stub $stub, boo
         return $a;
     }
 
+    /**
+     * @return array
+     */
     public static function castFlattenException(FlattenException $e, array $a, Stub $stub, bool $isNested)
     {
         if ($isNested) {

diff --git a/Caster/LinkStub.php b/Caster/LinkStub.php
@@ -60,7 +60,7 @@ public function __construct(string $label, int $line = 0, string $href = null)
         }
     }
 
-    private function getComposerRoot(string $file, bool &$inVendor)
+    private function getComposerRoot(string $file, bool &$inVendor): string|false
     {
         if (!isset(self::$vendorRoots)) {
             self::$vendorRoots = [];

diff --git a/Caster/StubCaster.php b/Caster/StubCaster.php
@@ -46,6 +46,9 @@ public static function castStub(Stub $c, array $a, Stub $stub, bool $isNested)
         return $a;
     }
 
+    /**
+     * @return array
+     */
     public static function castCutArray(CutArrayStub $c, array $a, Stub $stub, bool $isNested)
     {
         return $isNested ? $c->preservedSubset : $a;

diff --git a/Cloner/Data.php b/Cloner/Data.php
@@ -414,7 +414,7 @@ private function dumpChildren(DumperInterface $dumper, Cursor $parentCursor, arr
         return $hashCut;
     }
 
-    private function getStub(mixed $item)
+    private function getStub(mixed $item): mixed
     {
         if (!$item || !\is_array($item)) {
             return $item;

diff --git a/Cloner/DumperInterface.php b/Cloner/DumperInterface.php
@@ -20,6 +20,8 @@ interface DumperInterface
 {
     /**
      * Dumps a scalar value.
+     *
+     * @return void
      */
     public function dumpScalar(Cursor $cursor, string $type, string|int|float|bool|null $value);
 
@@ -29,6 +31,8 @@ public function dumpScalar(Cursor $cursor, string $type, string|int|float|bool|n
      * @param string $str The string being dumped
      * @param bool   $bin Whether $str is UTF-8 or binary encoded
      * @param int    $cut The number of characters $str has been cut by
+     *
+     * @return void
      */
     public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut);
 
@@ -38,6 +42,8 @@ public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut);
      * @param int             $type     A Cursor::HASH_* const for the type of hash
      * @param string|int|null $class    The object class, resource type or array count
      * @param bool            $hasChild When the dump of the hash has child item
+     *
+     * @return void
      */
     public function enterHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild);
 
@@ -48,6 +54,8 @@ public function enterHash(Cursor $cursor, int $type, string|int|null $class, boo
      * @param string|int|null $class    The object class, resource type or array count
      * @param bool            $hasChild When the dump of the hash has child item
      * @param int             $cut      The number of items the hash has been cut by
+     *
+     * @return void
      */
     public function leaveHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild, int $cut);
 }
diff --git a/Dumper/CliDumper.php b/Dumper/CliDumper.php
@@ -648,7 +648,7 @@ private function isWindowsTrueColor(): bool
         return $result;
     }
 
-    private function getSourceLink(string $file, int $line)
+    private function getSourceLink(string $file, int $line): string|false
     {
         if ($fmt = $this->displayOptions['fileLinkFormat']) {
             return \is_string($fmt) ? strtr($fmt, ['%f' => $file, '%l' => $line]) : ($fmt->format($file, $line) ?: 'file://'.$file.'#L'.$line);

diff --git a/Dumper/ContextualizedDumper.php b/Dumper/ContextualizedDumper.php
@@ -32,7 +32,7 @@ public function __construct(DataDumperInterface $wrappedDumper, array $contextPr
     }
 
     /**
-     * @return void
+     * @return string|null
      */
     public function dump(Data $data)
     {
@@ -41,6 +41,6 @@ public function dump(Data $data)
             $context[$contextProvider::class] = $contextProvider->getContext();
         }
 
-        $this->wrappedDumper->dump($data->withContext($context));
+        return $this->wrappedDumper->dump($data->withContext($context));
     }
 }
diff --git a/Dumper/DataDumperInterface.php b/Dumper/DataDumperInterface.php
@@ -20,5 +20,9 @@
  */
 interface DataDumperInterface
 {
+
+    /**
+     * @return string|null
+     */
     public function dump(Data $data);
 }
diff --git a/Dumper/HtmlDumper.php b/Dumper/HtmlDumper.php
@@ -82,12 +82,18 @@ public function __construct($output = null, string $charset = null, int $flags =
         $this->styles = static::$themes['dark'] ?? self::$themes['dark'];
     }
 
+    /**
+     * @return void
+     */
     public function setStyles(array $styles)
     {
         $this->headerIsDumped = false;
         $this->styles = $styles + $this->styles;
     }
 
+    /**
+     * @return void
+     */
     public function setTheme(string $themeName)
     {
         if (!isset(static::$themes[$themeName])) {
@@ -101,6 +107,8 @@ public function setTheme(string $themeName)
      * Configures display options.
      *
      * @param array $displayOptions A map of display options to customize the behavior
+     *
+     * @return void
      */
     public function setDisplayOptions(array $displayOptions)
     {
@@ -110,6 +118,8 @@ public function setDisplayOptions(array $displayOptions)
 
     /**
      * Sets an HTML header that will be dumped once in the output stream.
+     *
+     * @return void
      */
     public function setDumpHeader(?string $header)
     {
@@ -118,6 +128,8 @@ public function setDumpHeader(?string $header)
 
     /**
      * Sets an HTML prefix and suffix that will encapse every single dump.
+     *
+     * @return void
      */
     public function setDumpBoundaries(string $prefix, string $suffix)
     {
@@ -136,6 +148,8 @@ public function dump(Data $data, $output = null, array $extraDisplayOptions = []
 
     /**
      * Dumps the HTML header.
+     *
+     * @return string
      */
     protected function getDumpHeader()
     {
@@ -773,6 +787,9 @@ function showCurrent(state)
         return $this->dumpHeader = preg_replace('/\s+/', ' ', $line).'</style>'.$this->dumpHeader;
     }
 
+    /**
+     * @return void
+     */
     public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut)
     {
         if ('' === $str && isset($cursor->attr['img-data'], $cursor->attr['content-type'])) {
@@ -788,6 +805,9 @@ public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut)
         }
     }
 
+    /**
+     * @return void
+     */
     public function enterHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild)
     {
         if (Cursor::HASH_OBJECT === $type) {
@@ -816,6 +836,9 @@ public function enterHash(Cursor $cursor, int $type, string|int|null $class, boo
         }
     }
 
+    /**
+     * @return void
+     */
     public function leaveHash(Cursor $cursor, int $type, string|int|null $class, bool $hasChild, int $cut)
     {
         $this->dumpEllipsis($cursor, $hasChild, $cut);
@@ -923,6 +946,9 @@ protected function style(string $style, string $value, array $attr = []): string
         return $v;
     }
 
+    /**
+     * @return void
+     */
     protected function dumpLine(int $depth, bool $endOfValue = false)
     {
         if (-1 === $this->lastDepth) {
@@ -950,7 +976,7 @@ protected function dumpLine(int $depth, bool $endOfValue = false)
         AbstractDumper::dumpLine($depth);
     }
 
-    private function getSourceLink(string $file, int $line)
+    private function getSourceLink(string $file, int $line): string|false
     {
         $options = $this->extraDisplayOptions + $this->displayOptions;
 

diff --git a/Dumper/ServerDumper.php b/Dumper/ServerDumper.php
@@ -42,12 +42,14 @@ public function getContextProviders(): array
     }
 
     /**
-     * @return void
+     * @return string|null
      */
     public function dump(Data $data)
     {
         if (!$this->connection->write($data) && $this->wrappedDumper) {
-            $this->wrappedDumper->dump($data);
+            return $this->wrappedDumper->dump($data);
         }
+
+        return null;
     }
 }
diff --git a/Server/Connection.php b/Server/Connection.php
@@ -83,13 +83,13 @@ public function write(Data $data): bool
     }
 
     /**
-     * @psalm-return false|resource
+     * @return resource|null
      */
     private function createSocket()
     {
         set_error_handler(fn () => true);
         try {
-            return stream_socket_client($this->host, $errno, $errstr, 3, \STREAM_CLIENT_CONNECT | \STREAM_CLIENT_ASYNC_CONNECT);
+            return stream_socket_client($this->host, $errno, $errstr, 3, \STREAM_CLIENT_CONNECT | \STREAM_CLIENT_ASYNC_CONNECT) ?: null;
         } finally {
             restore_error_handler();
         }

diff --git a/VarDumper.php b/VarDumper.php
@@ -39,6 +39,8 @@ class VarDumper
 
     /**
      * @param string|null $label
+     *
+     * @return mixed
      */
     public static function dump(mixed $var/* , string $label = null */)
     {