mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
127 lines
3.2 KiB
PHP
127 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* Set of radio buttons designed to emulate a dropdown.
|
|
* It even uses the same constructor as a dropdown field.
|
|
*
|
|
* This field allows you to ensure that a form element is submitted is not optional and is part of a fixed set of
|
|
* data. This field uses the input type of radio. It's a direct subclass of {@link DropdownField},
|
|
* so the constructor and arguments are in the same format.
|
|
*
|
|
* <b>Usage</b>
|
|
*
|
|
* <code>
|
|
* new OptionsetField(
|
|
* $name = "Foobar",
|
|
* $title = "FooBar's optionset",
|
|
* $source = array(
|
|
* "1" => "Option 1",
|
|
* "2" => "Option 2",
|
|
* "3" => "Option 3",
|
|
* "4" => "Option 4",
|
|
* "5" => "Option 5"
|
|
* ),
|
|
* $value = "1"
|
|
* );
|
|
* </code>
|
|
*
|
|
* You can use the helper functions on data object set to create the source array. eg:
|
|
*
|
|
* <code>
|
|
* //Database request for the object
|
|
* $map = FooBar::get()->map();
|
|
* // returns an SS_Map object containing an array of ID => Title
|
|
*
|
|
* // Instantiate the OptionsetField
|
|
* $FieldList = new FieldList(
|
|
* new OptionsetField(
|
|
* $name = "Foobar",
|
|
* $title = "FooBar's optionset",
|
|
* $source = $map,
|
|
* $value = $map[0]
|
|
* )
|
|
* );
|
|
*
|
|
* // Pass the fields to the form constructor. etc
|
|
* </code>
|
|
*
|
|
* @see CheckboxSetField for multiple selections through checkboxes instead.
|
|
* @see DropdownField for a simple <select> field with a single element.
|
|
* @see TreeDropdownField for a rich and customizeable UI that can visualize a tree of selectable elements
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-basic
|
|
*/
|
|
class OptionsetField extends DropdownField {
|
|
|
|
/**
|
|
* @var Array
|
|
*/
|
|
protected $disabledItems = array();
|
|
|
|
function Field($properties = array()) {
|
|
$source = $this->getSource();
|
|
$odd = 0;
|
|
$options = array();
|
|
|
|
if($source) {
|
|
foreach($source as $value => $title) {
|
|
$itemID = $this->ID() . '_' . preg_replace('/[^a-zA-Z0-9]/', '', $value);
|
|
$odd = ($odd + 1) % 2;
|
|
$extraClass = $odd ? 'odd' : 'even';
|
|
$extraClass .= ' val' . preg_replace('/[^a-zA-Z0-9\-\_]/', '_', $value);
|
|
|
|
$options[] = new ArrayData(array(
|
|
'ID' => $itemID,
|
|
'Class' => $extraClass,
|
|
'Name' => $this->name,
|
|
'Value' => $value,
|
|
'Title' => $title,
|
|
'isChecked' => $value == $this->value,
|
|
'isDisabled' => $this->disabled || in_array($value, $this->disabledItems),
|
|
));
|
|
}
|
|
}
|
|
|
|
$properties = array_merge($properties, array(
|
|
'Options' => new ArrayList($options)
|
|
));
|
|
|
|
return $this->customise($properties)->renderWith(
|
|
$this->getTemplates()
|
|
);
|
|
}
|
|
|
|
function performReadonlyTransformation() {
|
|
// Source and values are DataObject sets.
|
|
$items = $this->getSource();
|
|
$field = new LookupField($this->name, $this->title ? $this->title : '', $items, $this->value);
|
|
$field->setForm($this->form);
|
|
$field->setReadonly(true);
|
|
|
|
return $field;
|
|
}
|
|
|
|
/**
|
|
* Mark certain elements as disabled,
|
|
* regardless of the {@link setDisabled()} settings.
|
|
*
|
|
* @param array $items Collection of array keys, as defined in the $source array
|
|
*/
|
|
function setDisabledItems($items) {
|
|
$this->disabledItems = $items;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return Array
|
|
*/
|
|
function getDisabledItems() {
|
|
return $this->disabledItems;
|
|
}
|
|
|
|
function ExtraOptions() {
|
|
return new ArrayList();
|
|
}
|
|
|
|
}
|