silverstripe-framework/forms/TextareaField.php
Damian Mooyman 5c9044a007 API Enforce default_cast for all field usages
API Introduce HTMLFragment as casting helper for HTMLText with shortcodes disabled
API Introduce DBField::CDATA for XML file value encoding
API RSSFeed now casts from the underlying model rather than by override
API Introduce CustomMethods::getExtraMethodConfig() to allow metadata to be queried
BUG Remove _call hack from VirtualPage
API Remove FormField::$dontEscape
API Introduce HTMLReadonlyField for non-editable readonly HTML
API FormField::Field() now returns string in many cases rather than DBField instance.
API Remove redundant *_val methods from ViewableData
API ViewableData::obj() no longer has a $forceReturnObject parameter as it always returns an object
BUG  Fix issue with ViewableData caching incorrect field values after being modified.
API Remove deprecated DB class methods
API Enforce plain text left/right formfield titles
2016-07-13 17:15:45 +12:00

128 lines
1.9 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.
*
* <code>
* new TextareaField(
* $name = "description",
* $title = "Description",
* $value = "This is the default description"
* );
* </code>
*
* @package forms
* @subpackage fields-basic
*/
class TextareaField extends FormField {
/**
* Value should be XML
*
* @var array
*/
private static $casting = array(
'Value' => 'Text',
'ValueEntities' => 'HTMLFragment',
);
/**
* Visible number of text lines.
*
* @var int
*/
protected $rows = 5;
/**
* Visible number of text columns.
*
* @var int
*/
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;
}
/**
* Gets number of rows
*
* @return int
*/
public function getRows() {
return $this->rows;
}
/**
* Set the number of columns in the textarea
*
* @param int $cols
*
* @return $this
*/
public function setColumns($cols) {
$this->cols = $cols;
return $this;
}
/**
* Gets the number of columns in this textarea
*
* @return int
*/
public function getColumns() {
return $this->cols;
}
/**
* {@inheritdoc}
*/
public function getAttributes() {
return array_merge(
parent::getAttributes(),
array(
'rows' => $this->getRows(),
'cols' => $this->getColumns(),
'value' => null,
'type' => null
)
);
}
/**
* {@inheritdoc}
*/
public function Type() {
$parent = parent::Type();
if($this->readonly) {
return $parent . ' readonly';
}
return $parent;
}
/**
* Return value with all values encoded in html entities
*
* @return string Raw HTML
*/
public function ValueEntities() {
return htmlentities($this->Value(), ENT_COMPAT, 'UTF-8');
}
}