This commit is contained in:
Fabien Potencier 2013-05-06 08:14:04 +02:00
parent a3492e65f9
commit aa5a2e97c1

View File

@ -31,14 +31,14 @@ interface ChoiceListInterface
/**
* Returns the list of choices
*
* @return array The choices with their indices as keys.
* @return array The choices with their indices as keys
*/
public function getChoices();
/**
* Returns the values for the choices
*
* @return array The values with the corresponding choice indices as keys.
* @return array The values with the corresponding choice indices as keys
*/
public function getValues();
@ -62,7 +62,7 @@ interface ChoiceListInterface
*
* @return array A nested array containing the views with the corresponding
* choice indices as keys on the lowest levels and the choice
* group names in the keys of the higher levels.
* group names in the keys of the higher levels
*/
public function getPreferredViews();
@ -86,7 +86,7 @@ interface ChoiceListInterface
*
* @return array A nested array containing the views with the corresponding
* choice indices as keys on the lowest levels and the choice
* group names in the keys of the higher levels.
* group names in the keys of the higher levels
*
* @see getPreferredValues
*/
@ -98,7 +98,7 @@ interface ChoiceListInterface
* The choices can have any data type.
*
* @param array $values An array of choice values. Not existing values in
* this array are ignored.
* this array are ignored
*
* @return array An array of choices with ascending, 0-based numeric keys
*/
@ -107,10 +107,10 @@ interface ChoiceListInterface
/**
* Returns the values corresponding to the given choices.
*
* The values must be a strings.
* The values must be strings.
*
* @param array $choices An array of choices. Not existing choices in this
* array are ignored.
* array are ignored
*
* @return array An array of choice values with ascending, 0-based numeric
* keys
@ -126,9 +126,9 @@ interface ChoiceListInterface
* The index "placeholder" is internally reserved.
*
* @param array $choices An array of choices. Not existing choices in this
* array are ignored.
* array are ignored
*
* @return array An array of indices with ascending, 0-based numeric keys.
* @return array An array of indices with ascending, 0-based numeric keys
*/
public function getIndicesForChoices(array $choices);
@ -141,9 +141,9 @@ interface ChoiceListInterface
* The index "placeholder" is internally reserved.
*
* @param array $values An array of choice values. Not existing values in
* this array are ignored.
* this array are ignored
*
* @return array An array of indices with ascending, 0-based numeric keys.
* @return array An array of indices with ascending, 0-based numeric keys
*/
public function getIndicesForValues(array $values);
}