mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-08-26 20:45:47 +02:00
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@79568 467b73ca-7a2a-4603-9d3b-597d59a354a9
244 lines
6.4 KiB
PHP
Executable File
244 lines
6.4 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* Displays a set of checkboxes as a logical group.
|
|
*
|
|
* ASSUMPTION -> IF you pass your source as an array, you pass values as an array too.
|
|
* Likewise objects are handled the same.
|
|
*
|
|
* @todo Document the different source data that can be used
|
|
* with this form field - e.g ComponentSet, DataObjectSet,
|
|
* array. Is it also appropriate to accept so many different
|
|
* types of data when just using an array would be appropriate?
|
|
*
|
|
* @todo Make use of FormField->createTag() to generate the
|
|
* HTML tag(s) for this field.
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-basic
|
|
*/
|
|
class CheckboxSetField extends OptionsetField {
|
|
|
|
protected $disabled = false;
|
|
|
|
/**
|
|
* @todo Explain different source data that can be used with this field,
|
|
* e.g. SQLMap, DataObjectSet or an array.
|
|
*
|
|
* @todo Should use CheckboxField FieldHolder rather than constructing own markup.
|
|
*/
|
|
function Field() {
|
|
Requirements::css(SAPPHIRE_DIR . '/css/CheckboxSetField.css');
|
|
|
|
$source = $this->source;
|
|
$values = $this->value;
|
|
|
|
// Get values from the join, if available
|
|
if(is_object($this->form)) {
|
|
$record = $this->form->getRecord();
|
|
if(!$values && $record && $record->hasMethod($this->name)) {
|
|
$funcName = $this->name;
|
|
$join = $record->$funcName();
|
|
if($join) {
|
|
foreach($join as $joinItem) {
|
|
$values[] = $joinItem->ID;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Source is not an array
|
|
if(!is_array($source) && !is_a($source, 'SQLMap')) {
|
|
if(is_array($values)) {
|
|
$items = $values;
|
|
} else {
|
|
// Source and values are DataObject sets.
|
|
if($values && is_a($values, 'DataObjectSet')) {
|
|
foreach($values as $object) {
|
|
if(is_a($object, 'DataObject')) {
|
|
$items[] = $object->ID;
|
|
}
|
|
}
|
|
} elseif($values && is_string($values)) {
|
|
$items = explode(',', $values);
|
|
$items = str_replace('{comma}', ',', $items);
|
|
}
|
|
}
|
|
} else {
|
|
// Sometimes we pass a singluar default value thats ! an array && !DataObjectSet
|
|
if(is_a($values, 'DataObjectSet') || is_array($values)) {
|
|
$items = $values;
|
|
} else {
|
|
$items = explode(',', $values);
|
|
$items = str_replace('{comma}', ',', $items);
|
|
}
|
|
}
|
|
|
|
if(is_array($source)) {
|
|
unset($source['']);
|
|
}
|
|
|
|
$odd = 0;
|
|
$options = '';
|
|
|
|
foreach($source as $index => $item) {
|
|
if(is_a($item, 'DataObject')) {
|
|
$key = $item->ID;
|
|
$value = $item->Title;
|
|
} else {
|
|
$key = $index;
|
|
$value = $item;
|
|
}
|
|
|
|
$odd = ($odd + 1) % 2;
|
|
$extraClass = $odd ? 'odd' : 'even';
|
|
$extraClass .= ' val' . str_replace(' ', '', $key);
|
|
$itemID = $this->id() . '_' . ereg_replace('[^a-zA-Z0-9]+', '', $key);
|
|
$checked = '';
|
|
|
|
if(isset($items)) {
|
|
$checked = (in_array($key, $items)) ? ' checked="checked"' : '';
|
|
}
|
|
|
|
$disabled = ($this->disabled) ? $disabled = ' disabled="disabled"' : '';
|
|
$options .= "<li class=\"$extraClass\"><input id=\"$itemID\" name=\"$this->name[$key]\" type=\"checkbox\" value=\"$key\"$checked $disabled class=\"checkbox\" /> <label for=\"$itemID\">$value</label></li>\n";
|
|
}
|
|
|
|
return "<ul id=\"{$this->id()}\" class=\"optionset checkboxsetfield{$this->extraClass()}\">\n$options</ul>\n";
|
|
}
|
|
|
|
function setDisabled($val) {
|
|
$this->disabled = $val;
|
|
}
|
|
|
|
/**
|
|
* Load a value into this CheckboxSetField
|
|
*/
|
|
function setValue($value, $obj = null) {
|
|
// If we're not passed a value directly, we can look for it in a relation method on the object passed as a second arg
|
|
if(!$value && $obj && $obj instanceof DataObject && $obj->hasMethod($this->name)) {
|
|
$funcName = $this->name;
|
|
$selected = $obj->$funcName();
|
|
$value = $selected->toDropdownMap('ID', 'ID');
|
|
}
|
|
|
|
parent::setValue($value, $obj);
|
|
}
|
|
|
|
/**
|
|
* Save the current value of this CheckboxSetField into a DataObject.
|
|
* If the field it is saving to is a has_many or many_many relationship,
|
|
* it is saved by setByIDList(), otherwise it creates a comma separated
|
|
* list for a standard DB text/varchar field.
|
|
*
|
|
* @param DataObject $record The record to save into
|
|
*/
|
|
function saveInto(DataObject $record) {
|
|
$fieldname = $this->name ;
|
|
|
|
if($fieldname && $record && ($record->has_many($fieldname) || $record->many_many($fieldname))) {
|
|
$idList = array();
|
|
if($this->value) foreach($this->value as $id => $bool) {
|
|
if($bool) $idList[] = $id;
|
|
}
|
|
$record->$fieldname()->setByIDList($idList);
|
|
} elseif($fieldname && $record) {
|
|
if($this->value) {
|
|
$this->value = str_replace(',', '{comma}', $this->value);
|
|
$record->$fieldname = implode(",", $this->value);
|
|
} else {
|
|
$record->$fieldname = '';
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the CheckboxSetField value as an array
|
|
* selected item keys.
|
|
*
|
|
* @return string
|
|
*/
|
|
function dataValue() {
|
|
if($this->value && is_array($this->value)) {
|
|
$filtered = array();
|
|
foreach($this->value as $item) {
|
|
if($item) {
|
|
$filtered[] = str_replace(",", "{comma}", $item);
|
|
}
|
|
}
|
|
|
|
return implode(',', $filtered);
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
function performDisabledTransformation() {
|
|
$clone = clone $this;
|
|
$clone->setDisabled(true);
|
|
|
|
return $clone;
|
|
}
|
|
|
|
/**
|
|
* Transforms the source data for this CheckboxSetField
|
|
* into a comma separated list of values.
|
|
*
|
|
* @return ReadonlyField
|
|
*/
|
|
function performReadonlyTransformation() {
|
|
$values = '';
|
|
$data = array();
|
|
|
|
$items = $this->value;
|
|
if($this->source) {
|
|
foreach($this->source as $source) {
|
|
if(is_object($source)) {
|
|
$sourceTitles[$source->ID] = $source->Title;
|
|
}
|
|
}
|
|
}
|
|
|
|
if($items) {
|
|
// Items is a DO Set
|
|
if(is_a($items, 'DataObjectSet')) {
|
|
foreach($items as $item) {
|
|
$data[] = $item->Title;
|
|
}
|
|
if($data) $values = implode(', ', $data);
|
|
|
|
// Items is an array or single piece of string (including comma seperated string)
|
|
} else {
|
|
if(!is_array($items)) {
|
|
$items = preg_split('/ *, */', trim($items));
|
|
}
|
|
|
|
foreach($items as $item) {
|
|
if(is_array($item)) {
|
|
$data[] = $item['Title'];
|
|
} elseif(is_array($this->source) && !empty($this->source[$item])) {
|
|
$data[] = $this->source[$item];
|
|
} elseif(is_a($this->source, 'ComponentSet')) {
|
|
$data[] = $sourceTitles[$item];
|
|
} else {
|
|
$data[] = $item;
|
|
}
|
|
}
|
|
|
|
$values = implode(', ', $data);
|
|
}
|
|
}
|
|
|
|
$title = ($this->title) ? $this->title : '';
|
|
|
|
$field = new ReadonlyField($this->name, $title, $values);
|
|
$field->setForm($this->form);
|
|
|
|
return $field;
|
|
}
|
|
|
|
function ExtraOptions() {
|
|
return FormField::ExtraOptions();
|
|
}
|
|
|
|
}
|
|
?>
|