ソースを参照

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

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).
Ryan Weaver 14 年 前
コミット
35ce9a37d1
1 ファイル変更15 行追加11 行削除
  1. 15 11
      src/Symfony/Component/Form/ChoiceField.php

+ 15 - 11
src/Symfony/Component/Form/ChoiceField.php

@@ -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');