[HttpFoundation] Add types to private properties

Signed-off-by: Alexander M. Turek <[email protected]>

Author: derrabus

AcceptHeader.php

@@ -27,12 +27,9 @@ class AcceptHeader
     /**
      * @var AcceptHeaderItem[]
      */
-    private $items = [];
+    private array $items = [];
 
-    /**
-     * @var bool
-     */
-    private $sorted = true;
+    private bool $sorted = true;
 
     /**
      * @param AcceptHeaderItem[] $items

AcceptHeaderItem.php

@@ -18,10 +18,10 @@
  */
 class AcceptHeaderItem
 {
-    private $value;
-    private $quality = 1.0;
-    private $index = 0;
-    private $attributes = [];
+    private string $value;
+    private float $quality = 1.0;
+    private int $index = 0;
+    private array $attributes = [];
 
     public function __construct(string $value, array $attributes = [])
     {

Cookie.php

@@ -30,11 +30,11 @@ class Cookie
     protected $secure;
     protected $httpOnly;
 
-    private $raw;
-    private $sameSite;
-    private $secureDefault = false;
+    private bool $raw;
+    private ?string $sameSite = null;
+    private bool $secureDefault = false;
 
-    private static $reservedCharsList = "=,; \t\r\n\v\f";
+    private const RESERVED_CHARS_LIST = "=,; \t\r\n\v\f";
     private const RESERVED_CHARS_FROM = ['=', ',', ';', ' ', "\t", "\r", "\n", "\v", "\f"];
     private const RESERVED_CHARS_TO = ['%3D', '%2C', '%3B', '%20', '%09', '%0D', '%0A', '%0B', '%0C'];
 
@@ -90,7 +90,7 @@ public static function create(string $name, string $value = null, int|string|\Da
     public function __construct(string $name, string $value = null, int|string|\DateTimeInterface $expire = 0, ?string $path = '/', string $domain = null, bool $secure = null, bool $httpOnly = true, bool $raw = false, ?string $sameSite = 'lax')
     {
         // from PHP source code
-        if ($raw && false !== strpbrk($name, self::$reservedCharsList)) {
+        if ($raw && false !== strpbrk($name, self::RESERVED_CHARS_LIST)) {
             throw new \InvalidArgumentException(sprintf('The cookie name "%s" contains invalid characters.', $name));
         }
 
@@ -199,7 +199,7 @@ public function withHttpOnly(bool $httpOnly = true): static
      */
     public function withRaw(bool $raw = true): static
     {
-        if ($raw && false !== strpbrk($this->name, self::$reservedCharsList)) {
+        if ($raw && false !== strpbrk($this->name, self::RESERVED_CHARS_LIST)) {
             throw new \InvalidArgumentException(sprintf('The cookie name "%s" contains invalid characters.', $this->name));
         }
 

ExpressionRequestMatcher.php

@@ -21,8 +21,8 @@
  */
 class ExpressionRequestMatcher extends RequestMatcher
 {
-    private $language;
-    private $expression;
+    private ExpressionLanguage $language;
+    private Expression|string $expression;
 
     public function setExpression(ExpressionLanguage $language, Expression|string $expression)
     {
@@ -32,7 +32,7 @@ public function setExpression(ExpressionLanguage $language, Expression|string $e
 
     public function matches(Request $request): bool
     {
-        if (!$this->language) {
+        if (!isset($this->language)) {
             throw new \LogicException('Unable to match the request as the expression language is not available.');
         }
 

File/UploadedFile.php

@@ -31,10 +31,10 @@
  */
 class UploadedFile extends File
 {
-    private $test;
-    private $originalName;
-    private $mimeType;
-    private $error;
+    private bool $test;
+    private string $originalName;
+    private string $mimeType;
+    private int $error;
 
     /**
      * Accepts the information of the uploaded file as provided by the PHP global $_FILES.

IpUtils.php

@@ -18,7 +18,7 @@
  */
 class IpUtils
 {
-    private static $checkedIps = [];
+    private static array $checkedIps = [];
 
     /**
      * This class should not be instantiated.

Request.php

@@ -205,19 +205,12 @@ class Request
 
     protected static $requestFactory;
 
-    /**
-     * @var string|null
-     */
-    private $preferredFormat;
-    private $isHostValid = true;
-    private $isForwardedValid = true;
-
-    /**
-     * @var bool|null
-     */
-    private $isSafeContentPreferred;
+    private ?string $preferredFormat = null;
+    private bool $isHostValid = true;
+    private bool $isForwardedValid = true;
+    private bool $isSafeContentPreferred;
 
-    private static $trustedHeaderSet = -1;
+    private static int $trustedHeaderSet = -1;
 
     private const FORWARDED_PARAMS = [
         self::HEADER_X_FORWARDED_FOR => 'for',
@@ -1665,20 +1658,16 @@ public function isXmlHttpRequest(): bool
      */
     public function preferSafeContent(): bool
     {
-        if (null !== $this->isSafeContentPreferred) {
+        if (isset($this->isSafeContentPreferred)) {
             return $this->isSafeContentPreferred;
         }
 
         if (!$this->isSecure()) {
             // see https://tools.ietf.org/html/rfc8674#section-3
-            $this->isSafeContentPreferred = false;
-
-            return $this->isSafeContentPreferred;
+            return $this->isSafeContentPreferred = false;
         }
 
-        $this->isSafeContentPreferred = AcceptHeader::fromString($this->headers->get('Prefer'))->has('safe');
-
-        return $this->isSafeContentPreferred;
+        return $this->isSafeContentPreferred = AcceptHeader::fromString($this->headers->get('Prefer'))->has('safe');
     }
 
     /*

RequestMatcher.php

@@ -18,40 +18,29 @@
  */
 class RequestMatcher implements RequestMatcherInterface
 {
-    /**
-     * @var string|null
-     */
-    private $path;
-
-    /**
-     * @var string|null
-     */
-    private $host;
-
-    /**
-     * @var int|null
-     */
-    private $port;
+    private ?string $path = null;
+    private ?string $host = null;
+    private ?int $port = null;
 
     /**
      * @var string[]
      */
-    private $methods = [];
+    private array $methods = [];
 
     /**
      * @var string[]
      */
-    private $ips = [];
+    private array $ips = [];
 
     /**
-     * @var array
+     * @var string[]
      */
-    private $attributes = [];
+    private array $attributes = [];
 
     /**
      * @var string[]
      */
-    private $schemes = [];
+    private array $schemes = [];
 
     /**
      * @param string|string[]|null $methods

RequestStack.php

@@ -24,7 +24,7 @@ class RequestStack
     /**
      * @var Request[]
      */
-    private $requests = [];
+    private array $requests = [];
 
     /**
      * Pushes a Request on the stack.

Session/Attribute/AttributeBag.php

@@ -16,8 +16,8 @@
  */
 class AttributeBag implements AttributeBagInterface, \IteratorAggregate, \Countable
 {
-    private $name = 'attributes';
-    private $storageKey;
+    private string $name = 'attributes';
+    private string $storageKey;
 
     protected $attributes = [];
 

Session/Flash/AutoExpireFlashBag.php

@@ -18,9 +18,9 @@
  */
 class AutoExpireFlashBag implements FlashBagInterface
 {
-    private $name = 'flashes';
-    private $flashes = ['display' => [], 'new' => []];
-    private $storageKey;
+    private string $name = 'flashes';
+    private array $flashes = ['display' => [], 'new' => []];
+    private string $storageKey;
 
     /**
      * @param string $storageKey The key used to store flashes in the session

Session/Flash/FlashBag.php

@@ -18,9 +18,9 @@
  */
 class FlashBag implements FlashBagInterface
 {
-    private $name = 'flashes';
-    private $flashes = [];
-    private $storageKey;
+    private string $name = 'flashes';
+    private array $flashes = [];
+    private string $storageKey;
 
     /**
      * @param string $storageKey The key used to store flashes in the session

Session/Session.php

@@ -32,16 +32,16 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable
 {
     protected $storage;
 
-    private $flashName;
-    private $attributeName;
-    private $data = [];
-    private $usageIndex = 0;
-    private $usageReporter;
+    private string $flashName;
+    private string $attributeName;
+    private array $data = [];
+    private int $usageIndex = 0;
+    private ?\Closure $usageReporter;
 
     public function __construct(SessionStorageInterface $storage = null, AttributeBagInterface $attributes = null, FlashBagInterface $flashes = null, callable $usageReporter = null)
     {
         $this->storage = $storage ?? new NativeSessionStorage();
-        $this->usageReporter = $usageReporter;
+        $this->usageReporter = $usageReporter instanceof \Closure || !\is_callable($usageReporter) ? $usageReporter : \Closure::fromCallable($usageReporter);
 
         $attributes = $attributes ?? new AttributeBag();
         $this->attributeName = $attributes->getName();

Session/SessionBagProxy.php

@@ -18,17 +18,17 @@
  */
 final class SessionBagProxy implements SessionBagInterface
 {
-    private $bag;
-    private $data;
-    private $usageIndex;
-    private $usageReporter;
+    private SessionBagInterface $bag;
+    private array $data;
+    private ?int $usageIndex;
+    private ?\Closure $usageReporter;
 
     public function __construct(SessionBagInterface $bag, array &$data, ?int &$usageIndex, ?callable $usageReporter)
     {
         $this->bag = $bag;
         $this->data = &$data;
         $this->usageIndex = &$usageIndex;
-        $this->usageReporter = $usageReporter;
+        $this->usageReporter = $usageReporter instanceof \Closure || !\is_callable($usageReporter) ? $usageReporter : \Closure::fromCallable($usageReporter);
     }
 
     public function getBag(): SessionBagInterface

Session/SessionFactory.php

@@ -22,15 +22,15 @@ class_exists(Session::class);
  */
 class SessionFactory implements SessionFactoryInterface
 {
-    private $requestStack;
-    private $storageFactory;
-    private $usageReporter;
+    private RequestStack $requestStack;
+    private SessionStorageFactoryInterface $storageFactory;
+    private ?\Closure $usageReporter;
 
     public function __construct(RequestStack $requestStack, SessionStorageFactoryInterface $storageFactory, callable $usageReporter = null)
     {
         $this->requestStack = $requestStack;
         $this->storageFactory = $storageFactory;
-        $this->usageReporter = $usageReporter;
+        $this->usageReporter = $usageReporter instanceof \Closure || !\is_callable($usageReporter) ? $usageReporter : \Closure::fromCallable($usageReporter);
     }
 
     public function createSession(): SessionInterface

Session/Storage/Handler/AbstractSessionHandler.php

@@ -22,11 +22,11 @@
  */
 abstract class AbstractSessionHandler implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
 {
-    private $sessionName;
-    private $prefetchId;
-    private $prefetchData;
-    private $newSessionId;
-    private $igbinaryEmptyData;
+    private string $sessionName;
+    private string $prefetchId;
+    private string $prefetchData;
+    private ?string $newSessionId = null;
+    private string $igbinaryEmptyData;
 
     public function open(string $savePath, string $sessionName): bool
     {
@@ -54,10 +54,10 @@ public function validateId(string $sessionId): bool
 
     public function read(string $sessionId): string
     {
-        if (null !== $this->prefetchId) {
+        if (isset($this->prefetchId)) {
             $prefetchId = $this->prefetchId;
             $prefetchData = $this->prefetchData;
-            $this->prefetchId = $this->prefetchData = null;
+            unset($this->prefetchId, $this->prefetchData);
 
             if ($prefetchId === $sessionId || '' === $prefetchData) {
                 $this->newSessionId = '' === $prefetchData ? $sessionId : null;
@@ -74,10 +74,8 @@ public function read(string $sessionId): string
 
     public function write(string $sessionId, string $data): bool
     {
-        if (null === $this->igbinaryEmptyData) {
-            // see https://github.com/igbinary/igbinary/issues/146
-            $this->igbinaryEmptyData = \function_exists('igbinary_serialize') ? igbinary_serialize([]) : '';
-        }
+        // see https://github.com/igbinary/igbinary/issues/146
+        $this->igbinaryEmptyData ??= \function_exists('igbinary_serialize') ? igbinary_serialize([]) : '';
         if ('' === $data || $this->igbinaryEmptyData === $data) {
             return $this->destroy($sessionId);
         }
@@ -89,7 +87,7 @@ public function write(string $sessionId, string $data): bool
     public function destroy(string $sessionId): bool
     {
         if (!headers_sent() && filter_var(ini_get('session.use_cookies'), \FILTER_VALIDATE_BOOLEAN)) {
-            if (!$this->sessionName) {
+            if (!isset($this->sessionName)) {
                 throw new \LogicException(sprintf('Session name cannot be empty, did you forget to call "parent::open()" in "%s"?.', static::class));
             }
             $cookie = SessionUtils::popSessionCookie($this->sessionName, $sessionId);

Session/Storage/Handler/MarshallingSessionHandler.php

@@ -18,8 +18,8 @@
  */
 class MarshallingSessionHandler implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
 {
-    private $handler;
-    private $marshaller;
+    private AbstractSessionHandler $handler;
+    private MarshallerInterface $marshaller;
 
     public function __construct(AbstractSessionHandler $handler, MarshallerInterface $marshaller)
     {