Fixed formatting of code, and added some documentation on what the source for this field should be

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@48319 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Sean Harvey 2008-01-20 08:58:04 +00:00
parent 20da7e8f95
commit e28361a313

View File

@ -6,19 +6,29 @@
*/ */
/** /**
* Grouped dropdown, using <optgroup>s. * Grouped dropdown, using <optgroup> tags.
* Returns a <select> tag containing all the appropriate <option> tags, with <optgroup> tags around the <option> tags as required *
* $source parameter (from DropdownField) must be a two dimensional array.
* The first level of the array is used for the <optgroup>, and the second
* level are the <options> for each group.
*
* Returns a <select> tag containing all the appropriate <option> tags, with
* <optgroup> tags around the <option> tags as required.
*
* @package forms * @package forms
* @subpackage fields-basic * @subpackage fields-basic
*/ */
class GroupedDropdownField extends DropdownField { class GroupedDropdownField extends DropdownField {
function Field() { function Field() {
// Initialisations // Initialisations
$options = ''; $options = '';
$classAttr = ''; $classAttr = '';
if($extraClass = trim($this->extraClass())) { if($extraClass = trim($this->extraClass())) {
$classAttr = "class=\"$extraClass\""; $classAttr = "class=\"$extraClass\"";
} }
if($this->source) {
foreach($this->source as $value => $title) { foreach($this->source as $value => $title) {
if(is_array($title)) { if(is_array($title)) {
$options .= "<optgroup label=\"$value\">"; $options .= "<optgroup label=\"$value\">";
@ -32,10 +42,12 @@ class GroupedDropdownField extends DropdownField {
$options .= "<option$selected value=\"$value\">$title</option>"; $options .= "<option$selected value=\"$value\">$title</option>";
} }
} }
}
$id = $this->id(); $id = $this->id();
return "<select $classAttr name=\"$this->name\" id=\"$id\">$options</select>"; return "<select $classAttr name=\"$this->name\" id=\"$id\">$options</select>";
} }
} }
?> ?>