Clean up TextareaField

This commit is contained in:
Christopher Pitt 2015-04-27 15:15:32 +12:00
parent 72ee96cd65
commit 53cf2929d4

View File

@ -1,12 +1,11 @@
<?php <?php
/** /**
* TextareaField creates a multi-line text field, * TextareaField creates a multi-line text field,
* allowing more data to be entered than a standard * allowing more data to be entered than a standard
* text field. It creates the <textarea> tag in the * text field. It creates the <textarea> tag in the
* form HTML. * form HTML.
* *
* <b>Usage</b>
*
* <code> * <code>
* new TextareaField( * new TextareaField(
* $name = "description", * $name = "description",
@ -14,22 +13,54 @@
* $value = "This is the default description" * $value = "This is the default description"
* ); * );
* </code> * </code>
* *
* @package forms * @package forms
* @subpackage fields-basic * @subpackage fields-basic
*/ */
class TextareaField extends FormField { class TextareaField extends FormField {
/** /**
* @var int Visible number of text lines. * Visible number of text lines.
*
* @var int
*/ */
protected $rows = 5; protected $rows = 5;
/** /**
* @var int Width of the text area (in average character widths) * Visible number of text columns.
*
* @var int
*/ */
protected $cols = 20; protected $cols = 20;
/**
* Set the number of rows in the textarea
*
* @param int $rows
*
* @return $this
*/
public function setRows($rows) {
$this->rows = $rows;
return $this;
}
/**
* Set the number of columns in the textarea
*
* @param int $cols
*
* @return $this
*/
public function setColumns($cols) {
$this->cols = $cols;
return $this;
}
/**
* {@inheritdoc}
*/
public function getAttributes() { public function getAttributes() {
return array_merge( return array_merge(
parent::getAttributes(), parent::getAttributes(),
@ -42,30 +73,22 @@ class TextareaField extends FormField {
); );
} }
/**
* {@inheritdoc}
*/
public function Type() { public function Type() {
return parent::Type() . ($this->readonly ? ' readonly' : ''); $parent = parent::Type();
}
if($this->readonly) {
/** return $parent . ' readonly';
* Set the number of rows in the textarea }
*
* @param int return $parent;
*/
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;
} }
/**
* @return string
*/
public function Value() { public function Value() {
return htmlentities($this->value, ENT_COMPAT, 'UTF-8'); return htmlentities($this->value, ENT_COMPAT, 'UTF-8');
} }