minor #41453 [Form] Document null support in NumberToLocalizedStringTransformer (mbabker)

nicolas-grekas · nicolas-grekas · commit f143c8fd1a25 · 2021-06-03T13:48:34.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Form] Document null support in NumberToLocalizedStringTransformer | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A `Symfony\Component\Form\Extension\Core\DataTransformer\NumberToLocalizedStringTransformer` explicitly checks for and returns nulls but these aren't documented in the class' doc blocks, which causes static analysis tools to report a false positive when checking for these null values elsewhere. This adds the missing null types to the doc blocks. Commits ------- 1fda3d0 Document null support in NumberToLocalizedStringTransformer
diff --git a/src/Symfony/Component/Form/Extension/Core/DataTransformer/MoneyToLocalizedStringTransformer.php b/src/Symfony/Component/Form/Extension/Core/DataTransformer/MoneyToLocalizedStringTransformer.php
@@ -45,7 +45,7 @@ public function __construct(?int $scale = 2, ?bool $grouping = true, ?int $round
     /**
      * Transforms a normalized format into a localized money string.
      *
-     * @param int|float $value Normalized number
+     * @param int|float|null $value Normalized number
      *
      * @return string Localized money string
      *
@@ -69,7 +69,7 @@ public function transform($value)
      *
      * @param string $value Localized money string
      *
-     * @return int|float Normalized number
+     * @return int|float|null Normalized number
      *
      * @throws TransformationFailedException if the given value is not a string
      *                                       or if the value can not be transformed
diff --git a/src/Symfony/Component/Form/Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php b/src/Symfony/Component/Form/Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php
@@ -98,7 +98,7 @@ public function __construct(int $scale = null, ?bool $grouping = false, ?int $ro
     /**
      * Transforms a number type into localized number.
      *
-     * @param int|float $value Number value
+     * @param int|float|null $value Number value
      *
      * @return string Localized value
      *
@@ -133,7 +133,7 @@ public function transform($value)
      *
      * @param string $value The localized value
      *
-     * @return int|float The numeric value
+     * @return int|float|null The numeric value
      *
      * @throws TransformationFailedException if the given value is not a string
      *                                       or if the value can not be transformed

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function __construct(?int $scale = 2, ?bool $grouping = true, ?int $round`
`45`	`45`	`/**`
`46`	`46`	`* Transforms a normalized format into a localized money string.`
`47`	`47`	`*`
`48`		`- * @param int\|float $value Normalized number`
	`48`	`+ * @param int\|float\|null $value Normalized number`
`49`	`49`	`*`
`50`	`50`	`* @return string Localized money string`
`51`	`51`	`*`
`@@ -69,7 +69,7 @@ public function transform($value)`
`69`	`69`	`*`
`70`	`70`	`* @param string $value Localized money string`
`71`	`71`	`*`
`72`		`- * @return int\|float Normalized number`
	`72`	`+ * @return int\|float\|null Normalized number`
`73`	`73`	`*`
`74`	`74`	`* @throws TransformationFailedException if the given value is not a string`
`75`	`75`	`* or if the value can not be transformed`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public function __construct(int $scale = null, ?bool $grouping = false, ?int $ro`
`98`	`98`	`/**`
`99`	`99`	`* Transforms a number type into localized number.`
`100`	`100`	`*`
`101`		`- * @param int\|float $value Number value`
	`101`	`+ * @param int\|float\|null $value Number value`
`102`	`102`	`*`
`103`	`103`	`* @return string Localized value`
`104`	`104`	`*`
`@@ -133,7 +133,7 @@ public function transform($value)`
`133`	`133`	`*`
`134`	`134`	`* @param string $value The localized value`
`135`	`135`	`*`
`136`		`- * @return int\|float The numeric value`
	`136`	`+ * @return int\|float\|null The numeric value`
`137`	`137`	`*`
`138`	`138`	`* @throws TransformationFailedException if the given value is not a string`
`139`	`139`	`* or if the value can not be transformed`