diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Form] Adding PHPDoc to ChoiceField and removing two unused options.

Browse Source 
I believe the empty_value option is just a leftover Django-style option for what value the field should have if left blank. I don't see this doing anything and find no reference to anything like it anywhere else.

The separator option functionality is currently handled as a parameter in the field render functions. I think this should be moved to an option on the field, but this reflects teh current functionality (i.e. this option is not used).
This commit is contained in:
Ryan Weaver 2011-01-21 14:25:05 -06:00 committed by Fabien Potencier
parent f73107cb9d
commit 35ce9a37d1
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/Symfony/Component/Form/ChoiceField.php
View File

@ -14,7 +14,21 @@ namespace Symfony\Component\Form;
use Symfony\Component\Form\Exception\InvalidOptionsException;
/**
* Lets the user select between different choices
* Lets the user select between different choices.
*
* Available options:
*
* * choices: An array of key-value pairs that will represent the choices.
* * preferred_choices: An array of choices (by key) that should be displayed
* above all other options in the field.
*
* The multiple and expanded options control exactly which HTML element
* that should be used to render this field:
*
* * expanded = false, multiple = false a drop-down select element;
* * expanded = false, multiple = true a multiple select element;
* * expanded = true, multiple = false a series of input radio elements;
* * expanded = true, multiple = true a series of input checkboxes.
*
* @author Bernhard Schussek <bernhard.schussek@symfony-project.com>
*/
@ -26,17 +40,12 @@ class ChoiceField extends HybridField
*/
protected $preferredChoices = array();
/**
* {@inheritDoc}
*/
protected function configure()
{
$this->addRequiredOption('choices');
$this->addOption('preferred_choices', array());
$this->addOption('separator', '----------');
$this->addOption('multiple', false);
$this->addOption('expanded', false);
$this->addOption('empty_value', '');
if (!is_array($this->getOption('choices'))) {
throw new InvalidOptionsException('The choices option must be an array', array('choices'));
@ -96,11 +105,6 @@ class ChoiceField extends HybridField
return array_diff_key($this->getOption('choices'), $this->preferredChoices);
}
public function getEmptyValue()
{
return $this->isRequired() ? false : $this->getOption('empty_value');
}
public function getLabel($choice)
{
$choices = $this->getOption('choices');