[Form] fixed phpdoc of ChoiceList

This commit is contained in:
Tobias Schultze 2012-07-24 01:04:42 +02:00
parent c7bc4791c4
commit 8da33eb5bc
3 changed files with 22 additions and 32 deletions

View File

@ -244,9 +244,7 @@ class ChoiceList implements ChoiceListInterface
* @param array $labels The labels corresponding to the choices.
* @param array $preferredChoices The preferred choices.
*
* @throws UnexpectedTypeException If the structure of the $labels array
* does not match the structure of the
* $choices array.
* @throws InvalidConfigurationException If no valid value or index could be created for a choice.
*/
protected function addChoices(&$bucketForPreferred, &$bucketForRemaining, array $choices, array $labels, array $preferredChoices)
{
@ -287,6 +285,8 @@ class ChoiceList implements ChoiceListInterface
* @param array $choices The list of choices in the group.
* @param array $labels The labels corresponding to the choices in the group.
* @param array $preferredChoices The preferred choices.
*
* @throws InvalidConfigurationException If no valid value or index could be created for a choice.
*/
protected function addChoiceGroup($group, &$bucketForPreferred, &$bucketForRemaining, array $choices, array $labels, array $preferredChoices)
{

View File

@ -57,7 +57,7 @@ class ObjectChoiceList extends ChoiceList
/**
* Creates a new object choice list.
*
* @param array $choices The array of choices. Choices may also be given
* @param array|\Traversable $choices The array of choices. Choices may also be given
* as hierarchy of unlimited depth. Hierarchies are
* created by creating nested arrays. The title of
* the sub-hierarchy can be stored in the array

View File

@ -74,20 +74,10 @@ class SimpleChoiceList extends ChoiceList
}
/**
* Recursively adds the given choices to the list.
* {@inheritdoc}
*
* Takes care of splitting the single $choices array passed in the
* constructor into choices and labels.
*
* @param array $bucketForPreferred
* @param array $bucketForRemaining
* @param array $choices
* @param array $labels
* @param array $preferredChoices
*
* @throws UnexpectedTypeException
*
* @see parent::addChoices
*/
protected function addChoices(&$bucketForPreferred, &$bucketForRemaining, array $choices, array $labels, array $preferredChoices)
{