[VarDumper] Add types to private properties

derrabus · derrabus · commit 9b39ca3f857d · 2021-09-08T13:42:22.000+02:00
Signed-off-by: Alexander M. Turek &lt;me@derrabus.de&gt;
diff --git a/src/Symfony/Component/VarDumper/Caster/ArgsStub.php b/src/Symfony/Component/VarDumper/Caster/ArgsStub.php
@@ -20,7 +20,7 @@
  */
 class ArgsStub extends EnumStub
 {
-    private static $parameters = [];
+    private static array $parameters = [];
 
     public function __construct(array $args, string $function, ?string $class)
     {
diff --git a/src/Symfony/Component/VarDumper/Caster/ExceptionCaster.php b/src/Symfony/Component/VarDumper/Caster/ExceptionCaster.php
@@ -44,7 +44,7 @@ class ExceptionCaster
         \E_STRICT => 'E_STRICT',
     ];
 
-    private static $framesCache = [];
+    private static array $framesCache = [];
 
     public static function castError(\Error $e, array $a, Stub $stub, bool $isNested, int $filter = 0)
     {
diff --git a/src/Symfony/Component/VarDumper/Caster/LinkStub.php b/src/Symfony/Component/VarDumper/Caster/LinkStub.php
@@ -20,8 +20,8 @@ class LinkStub extends ConstStub
 {
     public $inVendor = false;
 
-    private static $vendorRoots;
-    private static $composerRoots;
+    private static array $vendorRoots;
+    private static array $composerRoots = [];
 
     public function __construct(string $label, int $line = 0, string $href = null)
     {
@@ -65,7 +65,7 @@ public function __construct(string $label, int $line = 0, string $href = null)
 
     private function getComposerRoot(string $file, bool &$inVendor)
     {
-        if (null === self::$vendorRoots) {
+        if (!isset(self::$vendorRoots)) {
             self::$vendorRoots = [];
 
             foreach (get_declared_classes() as $class) {
diff --git a/src/Symfony/Component/VarDumper/Caster/MemcachedCaster.php b/src/Symfony/Component/VarDumper/Caster/MemcachedCaster.php
@@ -20,8 +20,8 @@
  */
 class MemcachedCaster
 {
-    private static $optionConstants;
-    private static $defaultOptions;
+    private static array $optionConstants;
+    private static array $defaultOptions;
 
     public static function castMemcached(\Memcached $c, array $a, Stub $stub, bool $isNested)
     {
diff --git a/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php b/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php
@@ -193,10 +193,15 @@ abstract class AbstractCloner implements ClonerInterface
     protected $maxString = -1;
     protected $minDepth = 1;
 
-    private $casters = [];
+    private array $casters = [];
+
+    /**
+     * @var callable|null
+     */
     private $prevErrorHandler;
-    private $classInfo = [];
-    private $filter = 0;
+
+    private array $classInfo = [];
+    private int $filter = 0;
 
     /**
      * @param callable[]|null $casters A map of casters
diff --git a/src/Symfony/Component/VarDumper/Cloner/Data.php b/src/Symfony/Component/VarDumper/Cloner/Data.php
@@ -19,13 +19,13 @@
  */
 class Data implements \ArrayAccess, \Countable, \IteratorAggregate
 {
-    private $data;
-    private $position = 0;
-    private $key = 0;
-    private $maxDepth = 20;
-    private $maxItemsPerDepth = -1;
-    private $useRefHandles = -1;
-    private $context = [];
+    private array $data;
+    private int $position = 0;
+    private int|string $key = 0;
+    private int $maxDepth = 20;
+    private int $maxItemsPerDepth = -1;
+    private int $useRefHandles = -1;
+    private array $context = [];
 
     /**
      * @param array $data An array as returned by ClonerInterface::cloneVar()
diff --git a/src/Symfony/Component/VarDumper/Cloner/Stub.php b/src/Symfony/Component/VarDumper/Cloner/Stub.php
@@ -39,7 +39,7 @@ class Stub
     public $position = 0;
     public $attr = [];
 
-    private static $defaultProperties = [];
+    private static array $defaultProperties = [];
 
     /**
      * @internal
diff --git a/src/Symfony/Component/VarDumper/Cloner/VarCloner.php b/src/Symfony/Component/VarDumper/Cloner/VarCloner.php
@@ -16,8 +16,8 @@
  */
 class VarCloner extends AbstractCloner
 {
-    private static $gid;
-    private static $arrayCache = [];
+    private static string $gid;
+    private static array $arrayCache = [];
 
     /**
      * {@inheritdoc}
@@ -44,9 +44,7 @@ protected function doClone(mixed $var): array
         $stub = null;                   // Stub capturing the main properties of an original item value
                                         // or null if the original value is used directly
 
-        if (!$gid = self::$gid) {
-            $gid = self::$gid = md5(random_bytes(6)); // Unique string used to detect the special $GLOBALS variable
-        }
+        $gid = self::$gid ??= md5(random_bytes(6)); // Unique string used to detect the special $GLOBALS variable
         $arrayStub = new Stub();
         $arrayStub->type = Stub::TYPE_ARRAY;
         $fromObjCast = false;
diff --git a/src/Symfony/Component/VarDumper/Command/Descriptor/CliDescriptor.php b/src/Symfony/Component/VarDumper/Command/Descriptor/CliDescriptor.php
@@ -27,14 +27,12 @@
  */
 class CliDescriptor implements DumpDescriptorInterface
 {
-    private $dumper;
-    private $lastIdentifier;
-    private $supportsHref;
+    private CliDumper $dumper;
+    private mixed $lastIdentifier = null;
 
     public function __construct(CliDumper $dumper)
     {
         $this->dumper = $dumper;
-        $this->supportsHref = method_exists(OutputFormatterStyle::class, 'setHref');
     }
 
     public function describe(OutputInterface $output, Data $data, array $context, int $clientId): void
@@ -66,8 +64,7 @@ public function describe(OutputInterface $output, Data $data, array $context, in
         if (isset($context['source'])) {
             $source = $context['source'];
             $sourceInfo = sprintf('%s on line %d', $source['name'], $source['line']);
-            $fileLink = $source['file_link'] ?? null;
-            if ($this->supportsHref && $fileLink) {
+            if ($fileLink = $source['file_link'] ?? null) {
                 $sourceInfo = sprintf('<href=%s>%s</>', $fileLink, $sourceInfo);
             }
             $rows[] = ['source', $sourceInfo];
@@ -77,11 +74,6 @@ public function describe(OutputInterface $output, Data $data, array $context, in
 
         $io->table([], $rows);
 
-        if (!$this->supportsHref && isset($fileLink)) {
-            $io->writeln(['<info>Open source in your IDE/browser:</info>', $fileLink]);
-            $io->newLine();
-        }
-
         $this->dumper->dump($data);
         $io->newLine();
     }
diff --git a/src/Symfony/Component/VarDumper/Command/Descriptor/HtmlDescriptor.php b/src/Symfony/Component/VarDumper/Command/Descriptor/HtmlDescriptor.php
@@ -24,8 +24,8 @@
  */
 class HtmlDescriptor implements DumpDescriptorInterface
 {
-    private $dumper;
-    private $initialized = false;
+    private HtmlDumper $dumper;
+    private bool $initialized = false;
 
     public function __construct(HtmlDumper $dumper)
     {
diff --git a/src/Symfony/Component/VarDumper/Command/ServerDumpCommand.php b/src/Symfony/Component/VarDumper/Command/ServerDumpCommand.php
@@ -37,10 +37,10 @@ class ServerDumpCommand extends Command
     protected static $defaultName = 'server:dump';
     protected static $defaultDescription = 'Start a dump server that collects and displays dumps in a single place';
 
-    private $server;
+    private DumpServer $server;
 
     /** @var DumpDescriptorInterface[] */
-    private $descriptors;
+    private array $descriptors;
 
     public function __construct(DumpServer $server, array $descriptors = [])
     {
diff --git a/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php b/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php
@@ -35,7 +35,7 @@ abstract class AbstractDumper implements DataDumperInterface, DumperInterface
     protected $indentPad = '  ';
     protected $flags;
 
-    private $charset = '';
+    private string $charset = '';
 
     /**
      * @param callable|resource|string|null $output  A line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput
diff --git a/src/Symfony/Component/VarDumper/Dumper/CliDumper.php b/src/Symfony/Component/VarDumper/Dumper/CliDumper.php
@@ -55,11 +55,11 @@ class CliDumper extends AbstractDumper
     protected $collapseNextHash = false;
     protected $expandNextHash = false;
 
-    private $displayOptions = [
+    private array $displayOptions = [
         'fileLinkFormat' => null,
     ];
 
-    private $handlesHrefGracefully;
+    private bool $handlesHrefGracefully;
 
     /**
      * {@inheritdoc}
@@ -441,10 +441,8 @@ protected function style(string $style, string $value, array $attr = []): string
             $this->colors = $this->supportsColors();
         }
 
-        if (null === $this->handlesHrefGracefully) {
-            $this->handlesHrefGracefully = 'JetBrains-JediTerm' !== getenv('TERMINAL_EMULATOR')
-                && (!getenv('KONSOLE_VERSION') || (int) getenv('KONSOLE_VERSION') > 201100);
-        }
+        $this->handlesHrefGracefully ??= 'JetBrains-JediTerm' !== getenv('TERMINAL_EMULATOR')
+            && (!getenv('KONSOLE_VERSION') || (int) getenv('KONSOLE_VERSION') > 201100);
 
         if (isset($attr['ellipsis'], $attr['ellipsis-type'])) {
             $prefix = substr($value, 0, -$attr['ellipsis']);
diff --git a/src/Symfony/Component/VarDumper/Dumper/ContextProvider/RequestContextProvider.php b/src/Symfony/Component/VarDumper/Dumper/ContextProvider/RequestContextProvider.php
@@ -22,8 +22,8 @@
  */
 final class RequestContextProvider implements ContextProviderInterface
 {
-    private $requestStack;
-    private $cloner;
+    private RequestStack $requestStack;
+    private VarCloner $cloner;
 
     public function __construct(RequestStack $requestStack)
     {
diff --git a/src/Symfony/Component/VarDumper/Dumper/ContextProvider/SourceContextProvider.php b/src/Symfony/Component/VarDumper/Dumper/ContextProvider/SourceContextProvider.php
@@ -25,10 +25,10 @@
  */
 final class SourceContextProvider implements ContextProviderInterface
 {
-    private $limit;
-    private $charset;
-    private $projectDir;
-    private $fileLinkFormatter;
+    private int $limit;
+    private ?string $charset;
+    private ?string $projectDir;
+    private ?FileLinkFormatter $fileLinkFormatter;
 
     public function __construct(string $charset = null, string $projectDir = null, FileLinkFormatter $fileLinkFormatter = null, int $limit = 9)
     {
diff --git a/src/Symfony/Component/VarDumper/Dumper/ContextualizedDumper.php b/src/Symfony/Component/VarDumper/Dumper/ContextualizedDumper.php
@@ -19,8 +19,8 @@
  */
 class ContextualizedDumper implements DataDumperInterface
 {
-    private $wrappedDumper;
-    private $contextProviders;
+    private DataDumperInterface $wrappedDumper;
+    private array $contextProviders;
 
     /**
      * @param ContextProviderInterface[] $contextProviders
diff --git a/src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php b/src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php
@@ -67,12 +67,12 @@ class HtmlDumper extends CliDumper
     protected $lastDepth = -1;
     protected $styles;
 
-    private $displayOptions = [
+    private array $displayOptions = [
         'maxDepth' => 1,
         'maxStringLength' => 160,
         'fileLinkFormat' => null,
     ];
-    private $extraDisplayOptions = [];
+    private array $extraDisplayOptions = [];
 
     /**
      * {@inheritdoc}
diff --git a/src/Symfony/Component/VarDumper/Dumper/ServerDumper.php b/src/Symfony/Component/VarDumper/Dumper/ServerDumper.php
@@ -22,8 +22,8 @@
  */
 class ServerDumper implements DataDumperInterface
 {
-    private $connection;
-    private $wrappedDumper;
+    private Connection $connection;
+    private ?DataDumperInterface $wrappedDumper;
 
     /**
      * @param string                     $host             The server host
diff --git a/src/Symfony/Component/VarDumper/Server/Connection.php b/src/Symfony/Component/VarDumper/Server/Connection.php
@@ -21,8 +21,12 @@
  */
 class Connection
 {
-    private $host;
-    private $contextProviders;
+    private string $host;
+    private array $contextProviders;
+
+    /**
+     * @var resource|null
+     */
     private $socket;
 
     /**
diff --git a/src/Symfony/Component/VarDumper/Server/DumpServer.php b/src/Symfony/Component/VarDumper/Server/DumpServer.php
@@ -24,9 +24,13 @@
  */
 class DumpServer
 {
-    private $host;
+    private string $host;
+    private ?LoggerInterface $logger;
+
+    /**
+     * @var resource|null
+     */
     private $socket;
-    private $logger;
 
     public function __construct(string $host, LoggerInterface $logger = null)
     {
diff --git a/src/Symfony/Component/VarDumper/Test/VarDumperTestTrait.php b/src/Symfony/Component/VarDumper/Test/VarDumperTestTrait.php
@@ -22,7 +22,7 @@ trait VarDumperTestTrait
     /**
      * @internal
      */
-    private $varDumperConfig = [
+    private array $varDumperConfig = [
         'casters' => [],
         'flags' => null,
     ];
diff --git a/src/Symfony/Component/VarDumper/VarDumper.php b/src/Symfony/Component/VarDumper/VarDumper.php
@@ -32,6 +32,9 @@
  */
 class VarDumper
 {
+    /**
+     * @var callable|null
+     */
     private static $handler;
 
     public static function dump(mixed $var)
@@ -43,7 +46,7 @@ public static function dump(mixed $var)
         return (self::$handler)($var);
     }
 
-    public static function setHandler(callable $callable = null)
+    public static function setHandler(callable $callable = null): ?callable
     {
         $prevHandler = self::$handler;
 

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`class ArgsStub extends EnumStub`
`22`	`22`	`{`
`23`		`- private static $parameters = [];`
	`23`	`+ private static array $parameters = [];`
`24`	`24`
`25`	`25`	`public function __construct(array $args, string $function, ?string $class)`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class ExceptionCaster`
`44`	`44`	`\E_STRICT => 'E_STRICT',`
`45`	`45`	`];`
`46`	`46`
`47`		`- private static $framesCache = [];`
	`47`	`+ private static array $framesCache = [];`
`48`	`48`
`49`	`49`	`public static function castError(\Error $e, array $a, Stub $stub, bool $isNested, int $filter = 0)`
`50`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@ class LinkStub extends ConstStub`
`20`	`20`	`{`
`21`	`21`	`public $inVendor = false;`
`22`	`22`
`23`		`- private static $vendorRoots;`
`24`		`- private static $composerRoots;`
	`23`	`+ private static array $vendorRoots;`
	`24`	`+ private static array $composerRoots = [];`
`25`	`25`
`26`	`26`	`public function __construct(string $label, int $line = 0, string $href = null)`
`27`	`27`	`{`
`@@ -65,7 +65,7 @@ public function __construct(string $label, int $line = 0, string $href = null)`
`65`	`65`
`66`	`66`	`private function getComposerRoot(string $file, bool &$inVendor)`
`67`	`67`	`{`
`68`		`- if (null === self::$vendorRoots) {`
	`68`	`+ if (!isset(self::$vendorRoots)) {`
`69`	`69`	`self::$vendorRoots = [];`
`70`	`70`
`71`	`71`	`foreach (get_declared_classes() as $class) {`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@`
`20`	`20`	`*/`
`21`	`21`	`class MemcachedCaster`
`22`	`22`	`{`
`23`		`- private static $optionConstants;`
`24`		`- private static $defaultOptions;`
	`23`	`+ private static array $optionConstants;`
	`24`	`+ private static array $defaultOptions;`
`25`	`25`
`26`	`26`	`public static function castMemcached(\Memcached $c, array $a, Stub $stub, bool $isNested)`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@`
`24`	`24`	`*/`
`25`	`25`	`class HtmlDescriptor implements DumpDescriptorInterface`
`26`	`26`	`{`
`27`		`- private $dumper;`
`28`		`- private $initialized = false;`
	`27`	`+ private HtmlDumper $dumper;`
	`28`	`+ private bool $initialized = false;`
`29`	`29`
`30`	`30`	`public function __construct(HtmlDumper $dumper)`
`31`	`31`	`{`