minor #30534 [Form] Fixed some phpdocs (Jules Pietri)
This PR was merged into the 3.4 branch.
Discussion
----------
[Form] Fixed some phpdocs
| Q | A
| ------------- | ---
| Branch? | 3.4
| Bug fix? | no
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | ~
| License | MIT
| Doc PR | https://github.com/symfony/symfony-docs/pull/6393
ref https://github.com/symfony/symfony-docs/issues/6144, https://github.com/symfony/symfony-docs/pull/6297, https://github.com/symfony/symfony/pull/14050
Commits
-------
b9162e8cfb
[Form] Fixed some phpdocs
This commit is contained in:
commit
83aeef1907
@ -15,9 +15,10 @@ namespace Symfony\Component\Form\ChoiceList;
|
|||||||
* A list of choices with arbitrary data types.
|
* A list of choices with arbitrary data types.
|
||||||
*
|
*
|
||||||
* The user of this class is responsible for assigning string values to the
|
* The user of this class is responsible for assigning string values to the
|
||||||
* choices. Both the choices and their values are passed to the constructor.
|
* choices annd for their uniqueness.
|
||||||
* Each choice must have a corresponding value (with the same array key) in
|
* Both the choices and their values are passed to the constructor.
|
||||||
* the value array.
|
* Each choice must have a corresponding value (with the same key) in
|
||||||
|
* the values array.
|
||||||
*
|
*
|
||||||
* @author Bernhard Schussek <bschussek@gmail.com>
|
* @author Bernhard Schussek <bschussek@gmail.com>
|
||||||
*/
|
*/
|
||||||
@ -43,12 +44,6 @@ class ArrayChoiceList implements ChoiceListInterface
|
|||||||
* @var int[]|string[]
|
* @var int[]|string[]
|
||||||
*/
|
*/
|
||||||
protected $originalKeys;
|
protected $originalKeys;
|
||||||
|
|
||||||
/**
|
|
||||||
* The callback for creating the value for a choice.
|
|
||||||
*
|
|
||||||
* @var callable
|
|
||||||
*/
|
|
||||||
protected $valueCallback;
|
protected $valueCallback;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -212,6 +207,8 @@ class ArrayChoiceList implements ChoiceListInterface
|
|||||||
/**
|
/**
|
||||||
* Checks whether the given choices can be cast to strings without
|
* Checks whether the given choices can be cast to strings without
|
||||||
* generating duplicates.
|
* generating duplicates.
|
||||||
|
* This method is responsible for preventing conflict between scalar values
|
||||||
|
* and the empty value.
|
||||||
*
|
*
|
||||||
* @param array $choices The choices
|
* @param array $choices The choices
|
||||||
* @param array|null $cache The cache for previously checked entries. Internal
|
* @param array|null $cache The cache for previously checked entries. Internal
|
||||||
@ -232,6 +229,7 @@ class ArrayChoiceList implements ChoiceListInterface
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// prevent having false casted to the empty string by isset()
|
||||||
$choice = false === $choice ? '0' : (string) $choice;
|
$choice = false === $choice ? '0' : (string) $choice;
|
||||||
|
|
||||||
if (isset($cache[$choice])) {
|
if (isset($cache[$choice])) {
|
||||||
|
@ -35,7 +35,25 @@ interface ChoiceListInterface
|
|||||||
/**
|
/**
|
||||||
* Returns the values for the choices.
|
* Returns the values for the choices.
|
||||||
*
|
*
|
||||||
* The values are strings that do not contain duplicates.
|
* The values are strings that do not contain duplicates:
|
||||||
|
*
|
||||||
|
* $form->add('field', 'choice', [
|
||||||
|
* 'choices' => [
|
||||||
|
* 'Decided' => ['Yes' => true, 'No' => false],
|
||||||
|
* 'Undecided' => ['Maybe' => null],
|
||||||
|
* ],
|
||||||
|
* ]);
|
||||||
|
*
|
||||||
|
* In this example, the result of this method is:
|
||||||
|
*
|
||||||
|
* [
|
||||||
|
* 'Yes' => '0',
|
||||||
|
* 'No' => '1',
|
||||||
|
* 'Maybe' => '2',
|
||||||
|
* ]
|
||||||
|
*
|
||||||
|
* Null and false MUST NOT conflict when being casted to string.
|
||||||
|
* For this some default incremented values SHOULD be computed.
|
||||||
*
|
*
|
||||||
* @return string[] The choice values
|
* @return string[] The choice values
|
||||||
*/
|
*/
|
||||||
@ -62,6 +80,12 @@ interface ChoiceListInterface
|
|||||||
* 'Undecided' => ['Maybe' => '2'],
|
* 'Undecided' => ['Maybe' => '2'],
|
||||||
* ]
|
* ]
|
||||||
*
|
*
|
||||||
|
* Nested arrays do not make sense in a view format unless
|
||||||
|
* they are used as a convenient way of grouping.
|
||||||
|
* If the implementation does not intend to support grouped choices,
|
||||||
|
* this method SHOULD be equivalent to {@link getValues()}.
|
||||||
|
* The $groupBy callback parameter SHOULD be used instead.
|
||||||
|
*
|
||||||
* @return string[] The choice values
|
* @return string[] The choice values
|
||||||
*/
|
*/
|
||||||
public function getStructuredValues();
|
public function getStructuredValues();
|
||||||
|
@ -28,8 +28,8 @@ interface ChoiceListFactoryInterface
|
|||||||
* The choices should be passed in the values of the choices array.
|
* The choices should be passed in the values of the choices array.
|
||||||
*
|
*
|
||||||
* Optionally, a callable can be passed for generating the choice values.
|
* Optionally, a callable can be passed for generating the choice values.
|
||||||
* The callable receives the choice as first and the array key as the second
|
* The callable receives the choice as only argument.
|
||||||
* argument.
|
* Null may be passed when the choice list contains the empty value.
|
||||||
*
|
*
|
||||||
* @param iterable $choices The choices
|
* @param iterable $choices The choices
|
||||||
* @param callable|null $value The callable generating the choice
|
* @param callable|null $value The callable generating the choice
|
||||||
@ -43,8 +43,8 @@ interface ChoiceListFactoryInterface
|
|||||||
* Creates a choice list that is loaded with the given loader.
|
* Creates a choice list that is loaded with the given loader.
|
||||||
*
|
*
|
||||||
* Optionally, a callable can be passed for generating the choice values.
|
* Optionally, a callable can be passed for generating the choice values.
|
||||||
* The callable receives the choice as first and the array key as the second
|
* The callable receives the choice as only argument.
|
||||||
* argument.
|
* Null may be passed when the choice list contains the empty value.
|
||||||
*
|
*
|
||||||
* @param ChoiceLoaderInterface $loader The choice loader
|
* @param ChoiceLoaderInterface $loader The choice loader
|
||||||
* @param callable|null $value The callable generating the choice
|
* @param callable|null $value The callable generating the choice
|
||||||
|
@ -28,8 +28,8 @@ interface ChoiceLoaderInterface
|
|||||||
* Loads a list of choices.
|
* Loads a list of choices.
|
||||||
*
|
*
|
||||||
* Optionally, a callable can be passed for generating the choice values.
|
* Optionally, a callable can be passed for generating the choice values.
|
||||||
* The callable receives the choice as first and the array key as the second
|
* The callable receives the choice as only argument.
|
||||||
* argument.
|
* Null may be passed when the choice list contains the empty value.
|
||||||
*
|
*
|
||||||
* @param callable|null $value The callable which generates the values
|
* @param callable|null $value The callable which generates the values
|
||||||
* from choices
|
* from choices
|
||||||
@ -45,8 +45,8 @@ interface ChoiceLoaderInterface
|
|||||||
* corresponding values in the given array.
|
* corresponding values in the given array.
|
||||||
*
|
*
|
||||||
* Optionally, a callable can be passed for generating the choice values.
|
* Optionally, a callable can be passed for generating the choice values.
|
||||||
* The callable receives the choice as first and the array key as the second
|
* The callable receives the choice as only argument.
|
||||||
* argument.
|
* Null may be passed when the choice list contains the empty value.
|
||||||
*
|
*
|
||||||
* @param string[] $values An array of choice values. Non-existing
|
* @param string[] $values An array of choice values. Non-existing
|
||||||
* values in this array are ignored
|
* values in this array are ignored
|
||||||
@ -63,8 +63,8 @@ interface ChoiceLoaderInterface
|
|||||||
* corresponding choices in the given array.
|
* corresponding choices in the given array.
|
||||||
*
|
*
|
||||||
* Optionally, a callable can be passed for generating the choice values.
|
* Optionally, a callable can be passed for generating the choice values.
|
||||||
* The callable receives the choice as first and the array key as the second
|
* The callable receives the choice as only argument.
|
||||||
* argument.
|
* Null may be passed when the choice list contains the empty value.
|
||||||
*
|
*
|
||||||
* @param array $choices An array of choices. Non-existing choices in
|
* @param array $choices An array of choices. Non-existing choices in
|
||||||
* this array are ignored
|
* this array are ignored
|
||||||
|
Reference in New Issue
Block a user