mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-28 20:29:15 +02:00
f5a39b5c2c
MINOR Documentation tweaks in TextareaField git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@64551 467b73ca-7a2a-4603-9d3b-597d59a354a9
91 lines
2.6 KiB
PHP
Executable File
91 lines
2.6 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* TextareaField creates a multi-line text field,
|
|
* allowing more data to be entered than a standard
|
|
* text field. It creates the <textarea> tag in the
|
|
* form HTML.
|
|
*
|
|
* @package forms
|
|
* @subpackage fields-basic
|
|
*/
|
|
class TextareaField extends FormField {
|
|
protected $rows, $cols, $disabled = false, $readonly = false;
|
|
|
|
/**
|
|
* Create a new textarea field.
|
|
*
|
|
* @param $name Field name
|
|
* @param $title Field title
|
|
* @param $rows The number of rows
|
|
* @param $cols The number of columns
|
|
* @param $value The current value
|
|
* @param $form The parent form. Auto-set when the field is placed in a form.
|
|
*/
|
|
function __construct($name, $title = null, $rows = 5, $cols = 20, $value = "", $form = null) {
|
|
$this->rows = $rows;
|
|
$this->cols = $cols;
|
|
parent::__construct($name, $title, $value, $form);
|
|
}
|
|
|
|
/**
|
|
* Create the <textarea> or <span> HTML tag with the
|
|
* attributes for this instance of TextareaField. This
|
|
* makes use of {@link FormField->createTag()} functionality.
|
|
*
|
|
* @return HTML code for the textarea OR span element
|
|
*/
|
|
function Field() {
|
|
if($this->readonly) {
|
|
$attributes = array(
|
|
'id' => $this->id(),
|
|
'class' => 'readonly' . (trim($this->extraClass()) ? (' ' . trim($this->extraClass())) : ''),
|
|
'name' => $this->name,
|
|
'readonly' => 'readonly'
|
|
);
|
|
|
|
return $this->createTag('span', $attributes, ($this->value ? $this->value : '<i>(not set)</i>'));
|
|
} else {
|
|
$attributes = array(
|
|
'id' => $this->id(),
|
|
'class' => (trim($this->extraClass()) ? trim($this->extraClass()) : ''),
|
|
'name' => $this->name,
|
|
'rows' => $this->rows,
|
|
'cols' => $this->cols
|
|
);
|
|
|
|
if($this->disabled) $attributes['disabled'] = 'disabled';
|
|
|
|
return $this->createTag('textarea', $attributes, $this->value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Performs a readonly transformation on this field. You should still be able
|
|
* to copy from this field, and it should still send when you submit
|
|
* the form it's attached to.
|
|
* The element shouldn't be both disabled and readonly at the same time.
|
|
*/
|
|
function performReadonlyTransformation() {
|
|
$this->readonly = true;
|
|
$this->disabled = false;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Performs a disabled transformation on this field. You shouldn't be able to
|
|
* copy from this field, and it should not send any data when you submit the
|
|
* form it's attached to.
|
|
* The element shouldn't be both disabled and readonly at the same time.
|
|
*/
|
|
function performDisabledTransformation() {
|
|
$this->disabled = true;
|
|
$this->readonly = false;
|
|
return $this;
|
|
}
|
|
|
|
function Type() {
|
|
return parent::Type() . ( $this->readonly ? ' readonly' : '' );
|
|
}
|
|
}
|
|
?>
|