minor #32935 [Form] Fix inconsistencies (vudaltsov)

nicolas-grekas · nicolas-grekas · commit dc8c267659b8 · 2019-08-05T16:17:43.000+02:00
This PR was squashed before being merged into the 3.4 branch (closes #32935). Discussion ---------- [Form] Fix inconsistencies | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a - ~~Use `@inheritdoc` in `Button` and `ButtonBuilder` where the method does satisfy the contract.~~ - ~~Add `This method should not be invoked` in all unsupported methods in `Button` and `ButtonBuilder` for consistency.~~ - ~~Fix the misused `idempotent` term in implementations of the `getFormConfig` method. It is wrong in the sense that the method does not always return the same result. You can `setAttribute` for instance and `getFormConfig` will return a different config object.~~ - ~~Add `if ($this->locked)` checks in the supported mutators.~~ - ~~Fix the arguments contract in the `ChoiceListFactoryInterface` — now it supports `PropertyPathInterface` explicitly. The downside of it — breaking LSP in the `DefaultChoiceListFactory`.~~ - Fix the `$label` phpdoc of the `ChoiceView` (arised in symfony/symfony#32237). - Use `PropertyPathInterface` instead of `PropertyPath` in `PropertyAccessDecorator` of the choice factory. - Fix `ArrayChoiceList::flatten` type hints. These changes are debatable, so feel free to correct me if I am wrong at some point. Ping @xabbuh , @HeahDude , @yceruto , @nicolas-grekas Commits ------- 360711ce4e [Form] Fix inconsistencies
diff --git a/ChoiceList/ArrayChoiceList.php b/ChoiceList/ArrayChoiceList.php
@@ -172,13 +172,13 @@ public function getValuesForChoices(array $choices)
     /**
      * Flattens an array into the given output variables.
      *
-     * @param array    $choices          The array to flatten
-     * @param callable $value            The callable for generating choice values
-     * @param array    $choicesByValues  The flattened choices indexed by the
-     *                                   corresponding values
-     * @param array    $keysByValues     The original keys indexed by the
-     *                                   corresponding values
-     * @param array    $structuredValues The values indexed by the original keys
+     * @param array      $choices          The array to flatten
+     * @param callable   $value            The callable for generating choice values
+     * @param array|null $choicesByValues  The flattened choices indexed by the
+     *                                     corresponding values
+     * @param array|null $keysByValues     The original keys indexed by the
+     *                                     corresponding values
+     * @param array|null $structuredValues The values indexed by the original keys
      *
      * @internal
      */
diff --git a/ChoiceList/Factory/ChoiceListFactoryInterface.php b/ChoiceList/Factory/ChoiceListFactoryInterface.php
@@ -32,8 +32,7 @@ interface ChoiceListFactoryInterface
      * Null may be passed when the choice list contains the empty value.
      *
      * @param iterable      $choices The choices
-     * @param callable|null $value   The callable generating the choice
-     *                               values
+     * @param callable|null $value   The callable generating the choice values
      *
      * @return ChoiceListInterface The choice list
      */
@@ -46,9 +45,7 @@ public function createListFromChoices($choices, $value = null);
      * The callable receives the choice as only argument.
      * Null may be passed when the choice list contains the empty value.
      *
-     * @param ChoiceLoaderInterface $loader The choice loader
-     * @param callable|null         $value  The callable generating the choice
-     *                                      values
+     * @param callable|null $value The callable generating the choice values
      *
      * @return ChoiceListInterface The choice list
      */
@@ -80,7 +77,6 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul
      * match the keys of the choices. The values should be arrays of HTML
      * attributes that should be added to the respective choice.
      *
-     * @param ChoiceListInterface $list             The choice list
      * @param array|callable|null $preferredChoices The preferred choices
      * @param callable|null       $label            The callable generating the
      *                                              choice labels
diff --git a/ChoiceList/View/ChoiceView.php b/ChoiceList/View/ChoiceView.php
@@ -30,10 +30,10 @@ class ChoiceView
     /**
      * Creates a new choice view.
      *
-     * @param mixed  $data  The original choice
-     * @param string $value The view representation of the choice
-     * @param string $label The label displayed to humans
-     * @param array  $attr  Additional attributes for the HTML tag
+     * @param mixed        $data  The original choice
+     * @param string       $value The view representation of the choice
+     * @param string|false $label The label displayed to humans; pass false to discard the label
+     * @param array        $attr  Additional attributes for the HTML tag
      */
     public function __construct($data, $value, $label, array $attr = [])
     {

Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,7 @@ interface ChoiceListFactoryInterface`
`32`	`32`	`* Null may be passed when the choice list contains the empty value.`
`33`	`33`	`*`
`34`	`34`	`* @param iterable $choices The choices`
`35`		`- * @param callable\|null $value The callable generating the choice`
`36`		`- * values`
	`35`	`+ * @param callable\|null $value The callable generating the choice values`
`37`	`36`	`*`
`38`	`37`	`* @return ChoiceListInterface The choice list`
`39`	`38`	`*/`
`@@ -46,9 +45,7 @@ public function createListFromChoices($choices, $value = null);`
`46`	`45`	`* The callable receives the choice as only argument.`
`47`	`46`	`* Null may be passed when the choice list contains the empty value.`
`48`	`47`	`*`
`49`		`- * @param ChoiceLoaderInterface $loader The choice loader`
`50`		`- * @param callable\|null $value The callable generating the choice`
`51`		`- * values`
	`48`	`+ * @param callable\|null $value The callable generating the choice values`
`52`	`49`	`*`
`53`	`50`	`* @return ChoiceListInterface The choice list`
`54`	`51`	`*/`
`@@ -80,7 +77,6 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul`
`80`	`77`	`* match the keys of the choices. The values should be arrays of HTML`
`81`	`78`	`* attributes that should be added to the respective choice.`
`82`	`79`	`*`
`83`		`- * @param ChoiceListInterface $list The choice list`
`84`	`80`	`* @param array\|callable\|null $preferredChoices The preferred choices`
`85`	`81`	`* @param callable\|null $label The callable generating the`
`86`	`82`	`* choice labels`