silverstripe-framework/forms/TextareaField.php
Ingo Schommer 559abecd56 API Copying instance props on FormField readonly/disabled transformations
Introduced new FormField->castedCopy() method
which tries to replicate the existing form field instance
as closely as possible.

Primarily, the fix was targeted at consistently passing
through FormField->description to all of its variations.
2012-12-14 01:58:04 +01:00

75 lines
1.3 KiB
PHP

<?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.
*
* <b>Usage</b>
*
* <code>
* new TextareaField(
* $name = "description",
* $title = "Description",
* $rows = 8,
* $cols = 3,
* $value = "This is the default description"
* );
* </code>
*
* @package forms
* @subpackage fields-basic
*/
class TextareaField extends FormField {
/**
* @var int Visible number of text lines.
*/
protected $rows = 5;
/**
* @var int Width of the text area (in average character widths)
*/
protected $cols = 20;
public function getAttributes() {
return array_merge(
parent::getAttributes(),
array(
'rows' => $this->rows,
'cols' => $this->cols,
'value' => null,
'type' => null
)
);
}
public function Type() {
return parent::Type() . ($this->readonly ? ' readonly' : '');
}
/**
* Set the number of rows in the textarea
*
* @param int
*/
public function setRows($rows) {
$this->rows = $rows;
return $this;
}
/**
* Set the number of columns in the textarea
*
* @return int
*/
public function setColumns($cols) {
$this->cols = $cols;
return $this;
}
public function Value() {
return htmlentities($this->value, ENT_COMPAT, 'UTF-8');
}
}