silverstripe-framework/forms/CheckboxField.php
Sean Harvey a16f55b068 ENHANCEMENT Clearer indication of setting disabled attribute in CheckboxField->Field() since the disabled attribute shouldn't be set if the field isn't to be disabled
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@64553 467b73ca-7a2a-4603-9d3b-597d59a354a9
2008-10-20 10:22:01 +00:00

131 lines
2.9 KiB
PHP
Executable File

<?php
/**
* Single checkbox field.
* @package forms
* @subpackage fields-basic
*/
class CheckboxField extends FormField {
/**
* Returns a single checkbox field - used by templates.
*
* Shouldn't this have a value?
*/
protected $disabled;
function Field() {
$attributes = array(
'type' => 'checkbox',
'class' => $this->extraClass(),
'id' => $this->id(),
'name' => $this->Name(),
'value' => 1,
'tabindex' => $this->getTabIndex()
);
if($this->disabled) $attributes['disabled'] = 'disabled';
return $this->createTag('input', $attributes);
}
function dataValue() {
return $this->value ? 1 : 0;
}
/**
* Checkboxes use the RightLabelledFieldHolder template, to put the field on the left
* and the label on the right. See {@link FormField::FieldHolder} for more information about
* how FieldHolder works.
*/
function FieldHolder() {
if($this->labelLeft) {
return parent::FieldHolder();
} else {
extract($this->getXMLValues(array( 'Name', 'Field', 'Title', 'Message', 'MessageType' )));
$messageBlock = isset($Message) ? "<span class=\"message $MessageType\">$Message</span>" : '';
$Type = $this->XML_val('Type');
return <<<HTML
<p id="$Name" class="field $Type">
$Field
<label class="right" for="{$this->id()}">$Title</label>
$messageBlock
</p>
HTML;
}
}
function useLabelLeft( $labelLeft = true ) {
$this->labelLeft = $labelLeft;
}
/**
* Returns a restricted field holder used within things like FieldGroups
*/
function SmallFieldHolder() {
$result = $this->Field();
if($t = $this->Title()) {
$result .= "<label for=\"" . $this->id() ."\">$t</label> ";
}
return $result;
}
/**
* Returns a readonly version of this field
*/
function performReadonlyTransformation() {
$field = new CheckboxField_Readonly($this->name, $this->title, $this->value ? 'Yes' : 'No');
$field->setForm($this->form);
return $field;
}
function performDisabledTransformation() {
$this->disabled = true;
return $this;
}
}
/**
* Readonly version of a checkbox field - "Yes" or "No".
* @package forms
* @subpackage fields-basic
*/
class CheckboxField_Readonly extends ReadonlyField {
function performReadonlyTransformation() {
return $this;
}
function setValue($val) {
$this->value = ($val) ? 'Yes' : 'No';
}
}
/**
* Single checkbox field, disabled
* @package forms
* @subpackage fields-basic
*/
class CheckboxField_Disabled extends CheckboxField {
protected $disabled = true;
/**
* Returns a single checkbox field - used by templates.
*/
function Field() {
$attributes = array(
'type' => 'checkbox',
'class' => $this->extraClass() . " text",
'id' => $this->id(),
'name' => $this->Name(),
'tabindex' => $this->getTabIndex(),
'checked' => ($this->value) ? 'checked' : false,
'disabled' => 'disabled'
);
return $this->createTag('input', $attributes);
}
}
?>