silverstripe-framework/src/Forms/SelectionGroup.php

133 lines
3.8 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\Forms;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\View\Requirements;
/**
2014-08-15 08:53:05 +02:00
* Represents a number of fields which are selectable by a radio
* button that appears at the beginning of each item. Using CSS, you can
* configure the field to only display its contents if the corresponding radio
* button is selected. Each item is defined through {@link SelectionGroup_Item}.
*
* @example <code>
* $items = array(
2016-11-29 00:31:16 +01:00
* new SelectionGroup_Item(
* 'one',
* new LiteralField('one', 'one view'),
* 'one title'
* ),
* new SelectionGroup_Item(
* 'two',
* new LiteralField('two', 'two view'),
* 'two title'
* ),
* );
* $field = new SelectionGroup('MyGroup', $items);
* </code>
*
* Caution: The form field does not include any JavaScript or CSS when used outside of the CMS context,
* since the required frontend dependencies are included through CMS bundling.
*/
2016-11-29 00:31:16 +01:00
class SelectionGroup extends CompositeField
{
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
/**
* Create a new selection group.
*
* @param string $name The field name of the selection group.
* @param array $items The list of {@link SelectionGroup_Item}
* @param mixed $value
*/
public function __construct($name, $items, $value = null)
{
if ($value !== null) {
$this->setValue($value);
}
2016-11-29 00:31:16 +01:00
$selectionItems = array();
2016-11-29 00:31:16 +01:00
foreach ($items as $key => $item) {
if ($item instanceof SelectionGroup_Item) {
$selectionItems[] = $item;
} else {
// Convert legacy format
if (strpos($key, '//') !== false) {
list($key,$title) = explode('//', $key, 2);
} else {
$title = null;
}
$selectionItems[] = new SelectionGroup_Item($key, $item, $title);
}
}
2016-11-29 00:31:16 +01:00
parent::__construct($selectionItems);
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
$this->setName($name);
}
2016-11-29 00:31:16 +01:00
public function FieldSet()
{
return $this->FieldList();
}
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
public function FieldList()
{
$items = parent::FieldList()->toArray();
$count = 0;
$newItems = array();
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
/** @var SelectionGroup_Item $item */
foreach ($items as $item) {
if ($this->value == $item->getValue()) {
$firstSelected = true;
$checked = true;
} else {
$firstSelected = false;
$checked = false;
}
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
$itemID = $this->ID() . '_' . (++$count);
// @todo Move into SelectionGroup_Item.ss template at some point.
$extra = array(
"RadioButton" => DBField::create_field('HTMLFragment', FormField::create_tag(
'input',
array(
'class' => 'selector',
'type' => 'radio',
'id' => $itemID,
'name' => $this->name,
'value' => $item->getValue(),
'checked' => $checked,
'aria-labelledby' => "title-{$itemID}",
)
)),
"RadioLabel" => DBField::create_field('HTMLFragment', FormField::create_tag(
'label',
array(
'id' => "title-{$itemID}",
'for' => $itemID
),
$item->getTitle()
)),
"Selected" => $firstSelected,
);
$newItems[] = $item->customise($extra);
}
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
return new ArrayList($newItems);
}
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
public function hasData()
{
return true;
}
2014-08-15 08:53:05 +02:00
2016-11-29 00:31:16 +01:00
public function FieldHolder($properties = array())
{
return parent::FieldHolder($properties);
}
}