minor #58563 [VarExporter] Fix phpdoc of LazyGhostTrait and LazyProxyTrait (alexandre-daubois)

fabpot · fabpot · commit c36093164b30 · 2024-10-18T09:54:43.000+02:00
This PR was merged into the 7.2 branch. Discussion ---------- [VarExporter] Fix phpdoc of `LazyGhostTrait` and `LazyProxyTrait` | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | - | License | MIT Commits ------- 327663a [VarExporter] Fix phpdoc of `LazyGhostTrait` and `LazyProxyTrait`
diff --git a/src/Symfony/Component/VarExporter/LazyGhostTrait.php b/src/Symfony/Component/VarExporter/LazyGhostTrait.php
@@ -27,7 +27,7 @@ trait LazyGhostTrait
      * Skipped properties should be indexed by their array-cast identifier, see
      * https://php.net/manual/language.types.array#language.types.array.casting
      *
-     * @param (\Closure(static):void   $initializer       The closure should initialize the object it receives as argument
+     * @param \Closure(static):void    $initializer       The closure should initialize the object it receives as argument
      * @param array<string, true>|null $skippedProperties An array indexed by the properties to skip, a.k.a. the ones
      *                                                    that the initializer doesn't initialize, if any
      * @param static|null              $instance
@@ -74,7 +74,7 @@ public static function createLazyGhost(\Closure $initializer, ?array $skippedPro
     /**
      * Returns whether the object is initialized.
      *
-     * @param $partial Whether partially initialized objects should be considered as initialized
+     * @param bool $partial Whether partially initialized objects should be considered as initialized
      */
     #[Ignore]
     public function isLazyObjectInitialized(bool $partial = false): bool
diff --git a/src/Symfony/Component/VarExporter/LazyObjectInterface.php b/src/Symfony/Component/VarExporter/LazyObjectInterface.php
@@ -16,7 +16,7 @@ interface LazyObjectInterface
     /**
      * Returns whether the object is initialized.
      *
-     * @param $partial Whether partially initialized objects should be considered as initialized
+     * @param bool $partial Whether partially initialized objects should be considered as initialized
      */
     public function isLazyObjectInitialized(bool $partial = false): bool;
 
diff --git a/src/Symfony/Component/VarExporter/LazyProxyTrait.php b/src/Symfony/Component/VarExporter/LazyProxyTrait.php
@@ -66,7 +66,7 @@ public static function createLazyProxy(\Closure $initializer, ?object $instance
     /**
      * Returns whether the object is initialized.
      *
-     * @param $partial Whether partially initialized objects should be considered as initialized
+     * @param bool $partial Whether partially initialized objects should be considered as initialized
      */
     #[Ignore]
     public function isLazyObjectInitialized(bool $partial = false): bool
diff --git a/src/Symfony/Component/VarExporter/VarExporter.php b/src/Symfony/Component/VarExporter/VarExporter.php
@@ -32,8 +32,8 @@ final class VarExporter
     /**
      * Exports a serializable PHP value to PHP code.
      *
-     * @param bool  &$isStaticValue Set to true after execution if the provided value is static, false otherwise
-     * @param array &$foundClasses  Classes found in the value are added to this list as both keys and values
+     * @param bool                              &$isStaticValue Set to true after execution if the provided value is static, false otherwise
+     * @param array<class-string, class-string> &$foundClasses  Classes found in the value are added to this list as both keys and values
      *
      * @throws ExceptionInterface When the provided value cannot be serialized
      */

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ interface LazyObjectInterface`
`16`	`16`	`/**`
`17`	`17`	`* Returns whether the object is initialized.`
`18`	`18`	`*`
`19`		`- * @param $partial Whether partially initialized objects should be considered as initialized`
	`19`	`+ * @param bool $partial Whether partially initialized objects should be considered as initialized`
`20`	`20`	`*/`
`21`	`21`	`public function isLazyObjectInitialized(bool $partial = false): bool;`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public static function createLazyProxy(\Closure $initializer, ?object $instance`
`66`	`66`	`/**`
`67`	`67`	`* Returns whether the object is initialized.`
`68`	`68`	`*`
`69`		`- * @param $partial Whether partially initialized objects should be considered as initialized`
	`69`	`+ * @param bool $partial Whether partially initialized objects should be considered as initialized`
`70`	`70`	`*/`
`71`	`71`	`#[Ignore]`
`72`	`72`	`public function isLazyObjectInitialized(bool $partial = false): bool`
Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,8 @@ final class VarExporter`
`32`	`32`	`/**`
`33`	`33`	`* Exports a serializable PHP value to PHP code.`
`34`	`34`	`*`
`35`		`- * @param bool &$isStaticValue Set to true after execution if the provided value is static, false otherwise`
`36`		`- * @param array &$foundClasses Classes found in the value are added to this list as both keys and values`
	`35`	`+ * @param bool &$isStaticValue Set to true after execution if the provided value is static, false otherwise`
	`36`	`+ * @param array<class-string, class-string> &$foundClasses Classes found in the value are added to this list as both keys and values`
`37`	`37`	`*`
`38`	`38`	`* @throws ExceptionInterface When the provided value cannot be serialized`
`39`	`39`	`*/`